Arvexa OS
Get API key
Guide

Quick Start

Make your first authenticated request

  1. 1Run the API with documentation enabled (API_DOCS_ENABLED unset in development, or true explicitly).
  2. 2Open this docs portal (default http://localhost:3001).
  3. 3Copy an example from any reference page.
  4. 4Replace placeholders such as YOUR_ORGANIZATION_ID with your tenant values.
  5. 5Send the request to your API base URL (default http://localhost:4000).

The OpenAPI document is available at GET /api/docs-json whenever docs are enabled.