Skip to main content
POST
Add a connector 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
provider
enum<string>
required

External source provider the connector pulls from.

Available options:
notion,
confluence,
google_drive,
sharepoint,
zendesk
connection_id
string

Connection id to pull from (max 200 chars). Optional on create — defaults to your organization id (the connection-id convention shared with the integrations catalog).

display_name
string

Human-readable label for the connector (1-200 chars). On update, null clears it.

scope
object

Which slice of the source to pull: space_keys, folder_ids, collection_ids, labels (all optional; empty = everything the connection can see).

sync_schedule
enum<string>

How often the source is re-pulled (default daily; manual syncs only on demand).

Available options:
manual,
hourly,
daily,
weekly
enabled
boolean

Pause (false) or resume (true) scheduled syncs. Default true.

auto_refresh_on_drift
boolean

When true, a detected source content drift auto-queues a resync; when false (default), drift only appears in the drift report.

Response

The created connector, in the standard { data, meta } envelope.

The created connector, in the standard { data, meta } envelope.