Introduction

Arvexa OS exposes a tenant-scoped HTTP API for pay-per-call and traffic operations.

This developer portal renders the NestJS-generated OpenAPI document as the single source of truth for endpoint reference. Guides on this site explain concepts; the API Reference is generated from /api/docs-json.

New public endpoints appear here automatically when controllers use the Arvexa Swagger conventions (@ApiTags, @ApiOperation, @ApiDocsMetadata, DTO @ApiProperty metadata).

Building a plugin rather than calling the API? Start at the Plugin Author Handbook guide, which covers project structure, the manifest, permissions, catalogs, runtime limits, testing, security, and the upload/install/publish lifecycle.