API Reference

Nairon has two APIs, each with its own host and its own OpenAPI document:

• platform-api — https://api.v2.nairon.xyz — the OpenAI-compatible data plane (chat, speech, transcription, realtime, batch, knowledge-base stores).
• service-api — https://service.v2.nairon.xyz — the REST control plane (flows, phone numbers, agent profiles, usage, partner/headless) plus an MCP server at /mcp.

For a narrative walkthrough with worked examples, see the Developer guide.

Raw OpenAPI documents

Both specs are generated by their respective live services and mirrored here for tooling (codegen, Postman/Insomnia import, etc.):

• platform-api.openapi.json
• service-api.openapi.json

You can also fetch the current spec directly from each service:

curl https://api.v2.nairon.xyz/openapi.json
curl https://service.v2.nairon.xyz/docs/json

Note

An interactive OpenAPI-rendered reference (starlight-openapi) is not wired into this build: that plugin currently requires Starlight ≥0.41 / Astro ≥7, and this site pins Starlight ^0.38 / Astro ^6 per the platform’s build constraints. The pages under /api/ are a hand-curated reference generated from the same OpenAPI documents linked above; revisit starlight-openapi once the site upgrades past Starlight 0.41.