v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB

connectors

`POST /orgs/{org_id}/connectors/{connector_id}/jobs`

Dispatch a job to a connector.

post/orgs/{org_id}/connectors/{connector_id}/jobs

Path parameters

org_idstring required

connector_idstring required

Request body

batch_rowsinteger nullable

Target rows per batch. Defaults to 5000.

cursorobject nullable

Resume checkpoint; omit for a full initial extract.

dest_tablestring required

Destination table inside the KB.

kb_idinteger required

Target KB (numeric id, same as the /k2 routes).

key_columnsstring[] nullable

Ordered destination PRIMARY KEY columns. Omit for a keyless table. Honored when the run builds the table (create/replace). Key columns are auto-added to a source.columns subset, so they only need to exist on the source table. Source these from the browse columns' pk_position for a faithful copy of the source key.

modestring nullable

create | append | replace | upsert. Defaults to create. upsert merges each batch on key_columns (rows with an existing key are overwritten, new keys inserted); requires non-empty key_columns. If the destination table doesn't exist yet, the first upsert builds it keyed.

placementstring nullable

Where the KB's data lives: hosted (control-plane KB, the default) or local (a KB runtime inside the connector's environment — requires the connector to advertise the kb:local capability).

Response

Job accepted and dispatched

job_idstring required