API Reference (live)

The complete, always-current endpoint reference is generated from the live OpenAPI 3.1 spec and rendered with Scalar. It is served directly by the API, so it never drifts from the running code.

Open the full API reference ↗

• OpenAPI spec (JSON): https://dev.aeliam.ai/api/v1/public/_docs/openapi.json
• Interactive reference (Scalar): https://dev.aeliam.ai/api/v1/public/_docs

If the embed doesn't load

Some browsers block cross-origin iframes. Use the Open the full API reference button above to view it in a dedicated tab.

What you'll find there

• Every endpoint grouped by resource: meta (key introspection, product catalogue & schemas), opportunities, clients, devis, automation (tarifications + job status), webhooks.
• Request/response schemas, query parameters, and per-endpoint examples.
• The two security schemes: ApiKeyAuth (X-API-Key) and BearerAuth (Authorization: Bearer).

For the conceptual guides, see Authentication, Idempotency & quotas and Webhooks.

Production

The same reference is published per environment. In production it will live at https://app.aeliam.ai/api/v1/public/_docs — see Environments.