Developer Portal
Arvexa OS
Production-grade API documentation powered by NestJS OpenAPI. Guides explain concepts; the reference updates automatically as annotated endpoints ship.
Guides
Start here before diving into the generated API reference.
- IntroductionWhat Arvexa OS API documentation coversGuide
- Quick StartMake your first authenticated requestGuide
- AuthenticationTenant headers and webhook signaturesGuide
- API Keys & CredentialsHow credentials are handled safelyGuide
- ErrorsHow to read HTTP error responsesGuide
- Documentation ConventionsChecklist for shipping new public APIsGuide
- Plugin Author HandbookBuild, validate, test, and ship an Arvexa pluginGuide
- Plugin Project StructureThe exact package layout, and why packing is reproducibleGuide
- Plugin ManifestEvery field of plugin-package-1.0, and the two manifest documentsGuide
- Permissions, Roles & AudiencesScopes, actor roles, account audiences, and deny-by-defaultGuide
- API & Hook CatalogsWhat a handler may call, and what may trigger itGuide
- Plugin Runtime & LimitsWhat exists inside the sandbox, and every budgetGuide
- Testing PluginsThe host harness, determinism replays, and local preflightGuide
- Plugin SecurityThe scan gate, secret hygiene, and webhook verificationGuide
- Upload, Install & PublishThe lifecycle, and the gate in front of each stepGuide
- Plugin TroubleshootingExit codes and the failures authors actually hitGuide
API Reference
Browse domains generated from live OpenAPI tags and metadata.
- PlatformPlatform10 groups · 290 endpointsExplore
- CommunicationsCommunications2 groups · 20 endpointsExplore
- RevenueRevenue9 groups · 180 endpointsExplore
- IntelligenceIntelligence13 groups · 234 endpointsExplore
- MarketplaceMarketplace2 groups · 34 endpointsExplore
- WebhooksWebhooks4 groups · 13 endpointsExplore
- SystemSystem9 groups · 202 endpointsExplore