Skip to main content
POST
/
orgs
/
{org_id}
/
connectors
/
{connector_id}
/
jobs
`POST /orgs/{org_id}/connectors/{connector_id}/jobs`
curl --request POST \
  --url https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dest_table": "<string>",
  "kb_id": 123,
  "source": {
    "connection_ref": "<string>",
    "cursor_column": "<string>",
    "table": "<string>",
    "kind": "postgres",
    "columns": [
      "<string>"
    ],
    "schema": "<string>"
  },
  "batch_rows": 1,
  "cursor": {},
  "mode": "<string>",
  "pacing": {
    "batch_delay_ms": 1,
    "max_dop": 1,
    "max_rows_per_sec": 1,
    "read_uncommitted": true
  },
  "placement": "<string>"
}
'
{
  "job_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

​
org_id
string
required
​
connector_id
string
required

Body

application/json
​
dest_table
string
required

Destination table inside the KB.

​
kb_id
integer<int64>
required

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

​
source
object
required

The source half of a dispatch, tagged by kind. Each variant maps to a SourceSpec and gates on the connector advertising the matching source:<kind> capability. Request shape: "source": { "kind": "sql_server", "connection_ref": "...", "table": "...", "cursor_column": "..." }.

​
batch_rows
integer<int32> | null

Target rows per batch. Defaults to 5000.

Required range: x >= 0
​
cursor
object | null

Resume checkpoint; omit for a full initial extract.

​
mode
string | null

create | append | replace. Defaults to create.

​
pacing
null | object

Optional load-shaping for gentle extraction against busy source systems. Omit for no throttle.

​
placement
string | null

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_id
string
required