Skip to content

Full API reference

Nairon has two APIs, each with its own host and its own OpenAPI document. This page is the full, unsplit reference for both — every endpoint, request/response schema, and auth requirement, generated directly from each service’s live /openapi.json. For a narrative walkthrough with worked examples scoped to your use case, see Platform API or Service API + MCP; for the client-console framing of the same underlying calls, see Client or Partner.

  • Platform API — https://api.testing.nairon.cloud — the OpenAI-compatible data plane (chat, speech, transcription, realtime, batch, knowledge-base stores).
  • Service API — https://service.testing.nairon.cloud — the REST control plane (flows, phone numbers, agent profiles, usage) 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 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.

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:

Terminal window
curl https://api.testing.nairon.cloud/openapi.json
curl https://service.testing.nairon.cloud/docs/json