Skip to main content
POST
Add a Knowledge Base Document

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
required

Trimmed before storage.

Required string length: 1 - 120
text
string
required

Trimmed only for blank validation; original string is stored. Maximum is 204800 UTF-8 bytes, not characters.

Required string length: 1 - 204800
source_url
string | null

No URL-format validation; empty string becomes null.

Response

Document accepted for asynchronous processing.

success
enum<boolean>
required
Available options:
true
document_id
string<uuid>
required
status
enum<string>
required
Available options:
pending
Last modified on September 8, 2026