Skip to main content
POST
Upload a document to a knowledge base

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Knowledge base id (kb_ prefixed).

Body

application/json
name
string
required

Display name (1-200 chars).

content
string
required

Document text content (max 10 MB). Use a multipart/form-data upload for binary files.

type
string
default:text

File-type hint — text, markdown, pdf, docx, csv, etc. Defaults to text.

source_url
string

Optional source URL the content came from (or an empty string).

metadata
object

Optional caller-supplied metadata persisted with the document.

Response

Upload accepted: the document record, in the standard { data, meta } envelope. Indexing is asynchronous — the document status starts as pending and settles on indexed or error.

Upload accepted: the document record, in the standard { data, meta } envelope. Indexing is asynchronous — the document status starts as pending and settles on indexed or error.