API doc
Nairon has two APIs, each with its own host and its own OpenAPI document. This tab is the full, unsplit reference for both — every endpoint, request/response schema, and auth requirement. For a narrative walkthrough with worked examples scoped to your surface, see the guide + developer section under App, Partner, Platform, or Headless.
- 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.
Both accept a secret API key (nrn_sk_...) as Authorization: Bearer nrn_sk_... or x-api-key.
service-api additionally rejects publishable keys on every route (they’re browser-facing only, e.g.
the web widget). See API keys for how keys are minted and scoped.
Realtime (platform-api)
Section titled “Realtime (platform-api)”Realtime speech-to-speech is a WebSocket upgrade, not a documented REST route, so it doesn’t appear in the OpenAPI reference below — see Platform: platform-API guide → Realtime for how to connect.
Raw OpenAPI documents
Section titled “Raw OpenAPI documents”Both specs are generated by their respective services and mirrored here for tooling (codegen, Postman/Insomnia import, etc.):
You can also fetch the current spec directly from each service:
curl https://api.v2.nairon.xyz/openapi.jsoncurl https://service.v2.nairon.xyz/docs/json