Skip to content

Service API + MCP

Service API (service.testing.nairon.cloud) is Nairon’s REST control plane for managing your account programmatically — reading your organization and projects, managing a Simple project’s agent (template, greeting, skills) or an Advanced project’s conversations and their designs, and creating, reading, updating, and deleting knowledge bases, integrations, phone numbers, web sessions, and API keys. An MCP server at /mcp exposes the same operations as tools for any MCP-capable client.

Every request is authenticated with a secret API key (nrn_sk_...), sent as Authorization: Bearer nrn_sk_... or x-api-key: nrn_sk_.... Publishable keys (the kind used by browser-facing surfaces like the web widget) are rejected on every route.

Mint a secret key from your project’s API keys page: in the dashboard at ui.testing.nairon.cloud (Setup → API keys) for a regular hotline or app project, or in the platform console at platform.testing.nairon.cloud for a platform project. See API keys for details. With the next service release, GET /v1/me returns the organization id, project id, scope, and name of the calling key (never the key itself) — see Me.

  • Resources — Organization, Project, Simple-project agent (+ skill/template catalogue), Conversation, Knowledge, Integrations, Numbers, Web Sessions, and Keys: what each one returns and every read and write operation available on it.
  • Conversation Design — the portable, implementation-independent document format a Conversation’s design is read and written as.
  • MCP — connecting an MCP client to /mcp and the full tool list.
  • Errors — the response envelope every error uses and the full error code reference.

See the full endpoint reference for the complete, generated request/response schema of every route.