Skip to content
Nairon Docs

Overview

Nairon Platform API v1

Section titled “Nairon Platform API v1”

OpenAI-compatible data plane: chat/speech/transcriptions/realtime/batch/knowledge-base routes, ClickHouse usage telemetry, DB-backed API-key auth. Point an OpenAI SDK’s base_url at this host’s /v1.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/v1/chat/completions
POST
/v1/audio/speech
POST
/v1/audio/transcriptions
GET
/v1/stores
POST
/v1/stores
GET
/v1/stores/{store_id}
DELETE
/v1/stores/{store_id}
GET
/v1/stores/{store_id}/information
POST
/v1/stores/{store_id}/information
DELETE
/v1/stores/{store_id}/information/{information_id}
POST
/v1/stores/{store_id}/query
GET
/v1/files
POST
/v1/files
GET
/v1/files/{file_id}
DELETE
/v1/files/{file_id}
GET
/v1/files/{file_id}/content
GET
/v1/batches
POST
/v1/batches
GET
/v1/batches/{batch_id}
POST
/v1/batches/{batch_id}/cancel
GET
/health
GET
/v1/me

Authentication

Section titled “Authentication”

HTTPBearer

Section titled “HTTPBearer”

Nairon platform secret key (nrn_sk_…) as a Bearer token

Security scheme type: http

APIKeyHeader

Section titled “APIKeyHeader”

Nairon platform secret key (nrn_sk_…)

Security scheme type: apiKey

Header parameter name: x-api-key