Skip to content
Nairon Docs

Overview

Nairon service-api v1

Section titled “Nairon service-api v1”

Platform control-plane API (flows, config, usage) + MCP server — Nairon version-2.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/healthz
GET
/v1/projects/{projectId}/flows
POST
/v1/projects/{projectId}/flows
GET
/v1/flows/{flowId}
DELETE
/v1/flows/{flowId}
PATCH
/v1/flows/{flowId}
GET
/v1/flows/{flowId}/versions
POST
/v1/flows/{flowId}/versions
GET
/v1/flow-versions/{versionId}
DELETE
/v1/flow-versions/{versionId}
PATCH
/v1/flow-versions/{versionId}
POST
/v1/flow-versions/{versionId}/activate
GET
/v1/projects/{projectId}/phone-numbers
POST
/v1/projects/{projectId}/phone-numbers
PATCH
/v1/phone-numbers/{phoneNumberId}/flow
GET
/v1/projects/{projectId}/agent-profiles
GET
/v1/agent-profiles/{agentProfileId}
PUT
/v1/agent-profiles/{agentProfileId}
GET
/v1/projects/{projectId}/usage
GET
/v1/orgs/{orgId}/usage
POST
/v1/partner/customers
GET
/v1/partner
GET
/v1/templates
POST
/v1/templates
GET
/v1/templates/{templateId}
GET
/v1/templates/{templateId}/versions
POST
/v1/templates/{templateId}/versions
POST
/v1/template-versions/{versionId}/publish
GET
/v1/templates/{templateId}/instances
POST
/v1/templates/{templateId}/instances
GET
/v1/instances/{instanceId}
POST
/v1/instances/{instanceId}/upgrade
GET
/mcp
POST
/mcp
DELETE
/mcp

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Secret API key (nrn_sk_…) as a Bearer token

Security scheme type: http

apiKeyHeader

Section titled “apiKeyHeader”

Secret API key (nrn_sk_…)

Security scheme type: apiKey

Header parameter name: x-api-key