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": "..." }.
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.
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.
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).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Timbal","colors":{"primary":"#000000","light":"#ffffff","dark":"#000000"},"logo":{"light":"https://mintcdn.com/timbaltechsl/pt3LfpScmY2Go19A/logo/light-small-1.svg?fit=max\u0026auto=format\u0026n=pt3LfpScmY2Go19A\u0026q=85\u0026s=fd26b0ce39e9e46d6dd08d81b611a9ea","dark":"https://mintcdn.com/timbaltechsl/pt3LfpScmY2Go19A/logo/dark-small-1.svg?fit=max\u0026auto=format\u0026n=pt3LfpScmY2Go19A\u0026q=85\u0026s=5739e93ab19cd4f38a7794d947cb547f"},"favicon":"https://mintcdn.com/timbaltechsl/SFKYoQkLzl5EA6mF/favicon.png?fit=max\u0026auto=format\u0026n=SFKYoQkLzl5EA6mF\u0026q=85\u0026s=426b0689f2269536b56cad9d7b4a8b2f","api":{"openapi":"api-reference/openapi.json"},"navbar":{"primary":{"type":"github","href":"https://github.com/timbal-ai/timbal"}},"footer":{"socials":{"website":"https://timbal.ai","github":"https://github.com/timbal-ai","linkedin":"https://linkedin.com/company/timbal-ai"}},"styling":{"codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"timbaltechsl","hasAudioNarration":false,"actualSubdomain":"timbaltechsl","customDomains":["docs.timbal.ai"],"gitSource":{"type":"github","owner":"timbal-ai","repo":"timbal","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ade6798f569cc6b3d4acf7e","collectionId":"be3351cf-9024-42b3-b592-146aa9c7992e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ade6798f569cc6b3d4acf7e"},"entitlements":{},"buildId":"6ade6798f569cc6b3d4acf7e","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":210},{"language":"default","tag":"Docs","count":56},{"language":"default","tag":"Organizations","count":54},{"language":"default","tag":"Projects","count":45},{"language":"default","tag":"Knowledge Bases","count":36},{"language":"default","tag":"Agents","count":31},{"language":"default","tag":"Examples","count":29},{"language":"default","tag":"Model Reference","count":28},{"language":"default","tag":"Connectors","count":26},{"language":"default","tag":"Evals","count":22}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/connectors/jobs/create","slug":"/api-reference/connectors/jobs/create","pageMetadata":{"title":"Create Connector Job","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/jobs","description":"Dispatch a job to a connector.","href":"/api-reference/connectors/jobs/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Dispatch a job to a connector.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Create Connector Job","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/jobs","description":"Dispatch a job to a connector.","href":"/api-reference/connectors/jobs/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["connectors"],"summary":"`POST /orgs/{org_id}/connectors/{connector_id}/jobs`","description":"Dispatch a job to a connector.","operationId":"create","parameters":["f83d3928-2bde-481d-be9a-dfc5f8c131cd","ea01a1ef-1c4b-4445-850c-ed458c18a79d"],"requestBody":"81031abd-a829-4e3d-87c7-4056b6a67dee","responses":{"202":"47c68e24-b558-4397-8f63-e133bd532ff2","400":"96490c09-7f95-4d4d-9a22-337b8ac533fd","403":"7933c1fb-46c6-41ea-8aab-942725052352","404":"7849f90a-fd80-495d-98df-7ccec41d15ec","422":"9c98d7a1-ba0e-41a4-9451-d6ebe0ff7a40"},"security":["15b1e5e4-30fc-4061-85b8-d318158a7321"],"method":"post","type":"path","servers":["063e6282-8e14-477c-a715-c7b30ccd340b","a9adc882-01d3-4459-9489-6baa7c24677b"],"path":"/orgs/{org_id}/connectors/{connector_id}/jobs","baseUrlOptions":["https://api.timbal.ai","https://api.dev.timbal.ai"],"title":"`POST /orgs/{org_id}/connectors/{connector_id}/jobs`","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f83d3928-2bde-481d-be9a-dfc5f8c131cd":{"name":"org_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"ea01a1ef-1c4b-4445-850c-ed458c18a79d":{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["kb_id","dest_table","source"],"properties":{"dest_table":{"type":"string","description":"Destination table inside the KB.","isRequired":true,"uniqueKey":"dest_table","typeLabel":"string"},"kb_id":{"type":"integer","format":"int64","description":"Target KB (numeric id, same as the `/k2` routes).","isRequired":true,"uniqueKey":"kb_id","typeLabel":"integer\u003cint64>"},"source":{"oneOf":[{"type":"object","description":"The source half of a dispatch, tagged by `kind`. Each variant maps to a\n`SourceSpec` and gates on the connector advertising the matching\n`source:\u003ckind>` capability. Request shape:\n`\"source\": { \"kind\": \"sql_server\", \"connection_ref\": \"...\", \"table\": \"...\", \"cursor_column\": \"...\" }`.","required":["kind","connection_ref","table"],"properties":{"connection_ref":{"type":"string","description":"Name of a connection in the connector's local `connections.json`.\nThe DSN itself never leaves the connector box.","isRequired":true,"uniqueKey":"source.oneOf.0.connection_ref","typeLabel":"string"},"table":{"type":"string","description":"Source table to extract.","isRequired":true,"uniqueKey":"source.oneOf.0.table","typeLabel":"string"},"kind":{"type":"string","enum":["postgres"],"isRequired":true,"uniqueKey":"source.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"columns":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"source.oneOf.0.columns.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Projection; omit for all columns.","uniqueKey":"source.oneOf.0.columns.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Projection; omit for all columns.","uniqueKey":"source.oneOf.0.columns.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.columns","typeLabel":"string[] | null"},"cursor_column":{"oneOf":[{"type":"string","description":"Monotonic column for incremental extraction (`id`, `updated_at`, ...).\nOmit for a *snapshot* (full-scan) pass over the whole table, unordered\nand with no checkpoint/resume — for tables with no usable cursor\n(requires the connector to advertise `extract:snapshot`, 0.1.25+). On a\nsync that makes every run a full refresh of the destination.","uniqueKey":"source.oneOf.0.cursor_column.oneOf.0","typeLabel":"string"},{"type":"null","description":"Monotonic column for incremental extraction (`id`, `updated_at`, ...).\nOmit for a *snapshot* (full-scan) pass over the whole table, unordered\nand with no checkpoint/resume — for tables with no usable cursor\n(requires the connector to advertise `extract:snapshot`, 0.1.25+). On a\nsync that makes every run a full refresh of the destination.","uniqueKey":"source.oneOf.0.cursor_column.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.cursor_column","typeLabel":"string | null"},"schema":{"oneOf":[{"type":"string","description":"Source schema; defaults to `public` (Postgres) / `dbo` (SQL Server).","uniqueKey":"source.oneOf.0.schema.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source schema; defaults to `public` (Postgres) / `dbo` (SQL Server).","uniqueKey":"source.oneOf.0.schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.schema","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"source.oneOf.0","typeLabel":"object"},{"type":"object","description":"The source half of a dispatch, tagged by `kind`. Each variant maps to a\n`SourceSpec` and gates on the connector advertising the matching\n`source:\u003ckind>` capability. Request shape:\n`\"source\": { \"kind\": \"sql_server\", \"connection_ref\": \"...\", \"table\": \"...\", \"cursor_column\": \"...\" }`.","required":["kind","connection_ref","table"],"properties":{"connection_ref":{"type":"string","description":"Name of a connection in the connector's local `connections.json`.\nThe DSN itself never leaves the connector box.","isRequired":true,"uniqueKey":"source.oneOf.1.connection_ref","typeLabel":"string"},"table":{"type":"string","description":"Source table to extract.","isRequired":true,"uniqueKey":"source.oneOf.1.table","typeLabel":"string"},"kind":{"type":"string","enum":["sql_server"],"isRequired":true,"uniqueKey":"source.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"columns":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"source.oneOf.1.columns.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Projection; omit for all columns.","uniqueKey":"source.oneOf.1.columns.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Projection; omit for all columns.","uniqueKey":"source.oneOf.1.columns.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.1.columns","typeLabel":"string[] | null"},"cursor_column":{"oneOf":[{"type":"string","description":"Monotonic column for incremental extraction (`id`, `updated_at`, ...).\nOmit for a *snapshot* (full-scan) pass over the whole table, unordered\nand with no checkpoint/resume — for tables with no usable cursor\n(requires the connector to advertise `extract:snapshot`, 0.1.25+). On a\nsync that makes every run a full refresh of the destination.","uniqueKey":"source.oneOf.1.cursor_column.oneOf.0","typeLabel":"string"},{"type":"null","description":"Monotonic column for incremental extraction (`id`, `updated_at`, ...).\nOmit for a *snapshot* (full-scan) pass over the whole table, unordered\nand with no checkpoint/resume — for tables with no usable cursor\n(requires the connector to advertise `extract:snapshot`, 0.1.25+). On a\nsync that makes every run a full refresh of the destination.","uniqueKey":"source.oneOf.1.cursor_column.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.1.cursor_column","typeLabel":"string | null"},"schema":{"oneOf":[{"type":"string","description":"Source schema; defaults to `public` (Postgres) / `dbo` (SQL Server).","uniqueKey":"source.oneOf.1.schema.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source schema; defaults to `public` (Postgres) / `dbo` (SQL Server).","uniqueKey":"source.oneOf.1.schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.1.schema","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"source.oneOf.1","typeLabel":"object"},{"type":"object","description":"The source half of a dispatch, tagged by `kind`. Each variant maps to a\n`SourceSpec` and gates on the connector advertising the matching\n`source:\u003ckind>` capability. Request shape:\n`\"source\": { \"kind\": \"sql_server\", \"connection_ref\": \"...\", \"table\": \"...\", \"cursor_column\": \"...\" }`.","required":["kind","connection_ref","table"],"properties":{"connection_ref":{"type":"string","description":"Name of a connection in the connector's local `connections.json`.\nThe DSN itself never leaves the connector box.","isRequired":true,"uniqueKey":"source.oneOf.2.connection_ref","typeLabel":"string"},"table":{"type":"string","description":"Source table to extract.","isRequired":true,"uniqueKey":"source.oneOf.2.table","typeLabel":"string"},"kind":{"type":"string","enum":["mysql"],"isRequired":true,"uniqueKey":"source.oneOf.2.kind","typeLabel":"enum\u003cstring>"},"columns":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"source.oneOf.2.columns.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Projection; omit for all columns.","uniqueKey":"source.oneOf.2.columns.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Projection; omit for all columns.","uniqueKey":"source.oneOf.2.columns.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.2.columns","typeLabel":"string[] | null"},"cursor_column":{"oneOf":[{"type":"string","description":"Monotonic column for incremental extraction (`id`, `updated_at`, ...).\nOmit for a *snapshot* (full-scan) pass over the whole table, unordered\nand with no checkpoint/resume — for tables with no usable cursor\n(requires the connector to advertise `extract:snapshot`, 0.1.25+). On a\nsync that makes every run a full refresh of the destination.","uniqueKey":"source.oneOf.2.cursor_column.oneOf.0","typeLabel":"string"},{"type":"null","description":"Monotonic column for incremental extraction (`id`, `updated_at`, ...).\nOmit for a *snapshot* (full-scan) pass over the whole table, unordered\nand with no checkpoint/resume — for tables with no usable cursor\n(requires the connector to advertise `extract:snapshot`, 0.1.25+). On a\nsync that makes every run a full refresh of the destination.","uniqueKey":"source.oneOf.2.cursor_column.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.2.cursor_column","typeLabel":"string | null"},"schema":{"oneOf":[{"type":"string","description":"Source schema; defaults to `public` (Postgres) / `dbo` (SQL Server).","uniqueKey":"source.oneOf.2.schema.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source schema; defaults to `public` (Postgres) / `dbo` (SQL Server).","uniqueKey":"source.oneOf.2.schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.2.schema","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"source.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"source","typeLabel":"object"},"batch_rows":{"oneOf":[{"type":"integer","format":"int32","description":"Target rows per batch. Defaults to 5000.","minimum":0,"uniqueKey":"batch_rows.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Target rows per batch. Defaults to 5000.","minimum":0,"uniqueKey":"batch_rows.oneOf.1","typeLabel":"null"}],"uniqueKey":"batch_rows","typeLabel":"integer\u003cint32> | null"},"cursor":{"oneOf":[{"type":"object","description":"Resume checkpoint; omit for a full initial extract.","uniqueKey":"cursor.oneOf.0","typeLabel":"object"},{"type":"null","description":"Resume checkpoint; omit for a full initial extract.","uniqueKey":"cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"cursor","typeLabel":"object | null"},"key_columns":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"key_columns.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Ordered destination `PRIMARY KEY` columns. Omit for a keyless table.\nHonored when the run builds the table (`create`/`replace`). Key columns\nare auto-added to a `source.columns` subset, so they only need to exist\non the source table. Source these from the browse columns' `pk_position`\nfor a faithful copy of the source key.","uniqueKey":"key_columns.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Ordered destination `PRIMARY KEY` columns. Omit for a keyless table.\nHonored when the run builds the table (`create`/`replace`). Key columns\nare auto-added to a `source.columns` subset, so they only need to exist\non the source table. Source these from the browse columns' `pk_position`\nfor a faithful copy of the source key.","uniqueKey":"key_columns.oneOf.1","typeLabel":"null"}],"uniqueKey":"key_columns","typeLabel":"string[] | null"},"mode":{"oneOf":[{"type":"string","description":"`create` | `append` | `replace` | `upsert`. Defaults to `create`.\n`upsert` merges each batch on `key_columns` (rows with an existing key are\noverwritten, new keys inserted); requires non-empty `key_columns`. If the\ndestination table doesn't exist yet, the first upsert builds it keyed.","uniqueKey":"mode.oneOf.0","typeLabel":"string"},{"type":"null","description":"`create` | `append` | `replace` | `upsert`. Defaults to `create`.\n`upsert` merges each batch on `key_columns` (rows with an existing key are\noverwritten, new keys inserted); requires non-empty `key_columns`. If the\ndestination table doesn't exist yet, the first upsert builds it keyed.","uniqueKey":"mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"mode","typeLabel":"string | null"},"pacing":{"oneOf":[{"type":"null","uniqueKey":"pacing.oneOf.0","typeLabel":"null"},{"type":"object","description":"Optional load-shaping for gentle extraction against busy source systems.\nOmit for no throttle.","properties":{"batch_delay_ms":{"oneOf":[{"type":"integer","format":"int64","description":"Sleep (ms) between batches. `0`/omitted = none.","minimum":0,"uniqueKey":"pacing.oneOf.1.batch_delay_ms.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Sleep (ms) between batches. `0`/omitted = none.","minimum":0,"uniqueKey":"pacing.oneOf.1.batch_delay_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing.oneOf.1.batch_delay_ms","typeLabel":"integer\u003cint64> | null"},"max_dop":{"oneOf":[{"type":"integer","format":"int32","description":"SQL Server only: `OPTION (MAXDOP n)` to cap server-side query\nparallelism. `1` pins single-threaded. Ignored by other sources.","minimum":0,"uniqueKey":"pacing.oneOf.1.max_dop.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"SQL Server only: `OPTION (MAXDOP n)` to cap server-side query\nparallelism. `1` pins single-threaded. Ignored by other sources.","minimum":0,"uniqueKey":"pacing.oneOf.1.max_dop.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing.oneOf.1.max_dop","typeLabel":"integer\u003cint32> | null"},"max_rows_per_sec":{"oneOf":[{"type":"integer","format":"int32","description":"Cap on sustained rows/sec across the job. Omit = unlimited.","minimum":0,"uniqueKey":"pacing.oneOf.1.max_rows_per_sec.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Cap on sustained rows/sec across the job. Omit = unlimited.","minimum":0,"uniqueKey":"pacing.oneOf.1.max_rows_per_sec.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing.oneOf.1.max_rows_per_sec","typeLabel":"integer\u003cint32> | null"},"read_uncommitted":{"oneOf":[{"type":"boolean","description":"SQL Server only: read with `READ UNCOMMITTED` (no shared locks, never\nblocks the source's OLTP; dirty reads OK for snapshots). No-op elsewhere.","uniqueKey":"pacing.oneOf.1.read_uncommitted.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"SQL Server only: read with `READ UNCOMMITTED` (no shared locks, never\nblocks the source's OLTP; dirty reads OK for snapshots). No-op elsewhere.","uniqueKey":"pacing.oneOf.1.read_uncommitted.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing.oneOf.1.read_uncommitted","typeLabel":"boolean | null"}},"uniqueKey":"pacing.oneOf.1","typeLabel":"object"}],"uniqueKey":"pacing","typeLabel":"null | object"},"placement":{"oneOf":[{"type":"string","description":"Where the KB's data lives: `hosted` (control-plane KB, the default) or\n`local` (a KB runtime inside the connector's environment — requires the\nconnector to advertise the `kb:local` capability).","uniqueKey":"placement.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where the KB's data lives: `hosted` (control-plane KB, the default) or\n`local` (a KB runtime inside the connector's environment — requires the\nconnector to advertise the `kb:local` capability).","uniqueKey":"placement.oneOf.1","typeLabel":"null"}],"uniqueKey":"placement","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"dest_table":"\u003cstring>","kb_id":123,"source":{"connection_ref":"\u003cstring>","table":"\u003cstring>","kind":"postgres","columns":["\u003cstring>"],"cursor_column":"\u003cstring>","schema":"\u003cstring>"},"batch_rows":1,"cursor":{},"key_columns":["\u003cstring>"],"mode":"\u003cstring>","pacing":{"batch_delay_ms":1,"max_dop":1,"max_rows_per_sec":1,"read_uncommitted":true},"placement":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"47c68e24-b558-4397-8f63-e133bd532ff2":{"description":"Job accepted and dispatched","content":{"application/json":{"schema":{"type":"object","required":["job_id"],"properties":{"job_id":{"type":"string","isRequired":true,"uniqueKey":"job_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"job_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"96490c09-7f95-4d4d-9a22-337b8ac533fd":{"description":"Invalid request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7933c1fb-46c6-41ea-8aab-942725052352":{"description":"Forbidden","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7849f90a-fd80-495d-98df-7ccec41d15ec":{"description":"Connector or KB not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9c98d7a1-ba0e-41a4-9451-d6ebe0ff7a40":{"description":"Unprocessable entity","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"15b1e5e4-30fc-4061-85b8-d318158a7321":{"bearer_auth":{"type":"http","scheme":"bearer","description":"Timbal API key. Obtain your API key from the Timbal platform settings. See [Authentication](/api-reference/authentication) for more information.","scopes":[]}}},"servers":{"063e6282-8e14-477c-a715-c7b30ccd340b":{"url":"https://api.timbal.ai","description":"Production"},"a9adc882-01d3-4459-9489-6baa7c24677b":{"url":"https://api.dev.timbal.ai","description":"Development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Timbal API key. Obtain your API key from the Timbal platform settings. See [Authentication](/api-reference/authentication) for more information.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Timbal API key. Obtain your API key from the Timbal platform settings. See [Authentication](/api-reference/authentication) for more information.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"timbaltechsl","siteName":"Timbal","title":"Create Connector Job - Timbal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-28T10:40:37.930Z","originalFileLocation":"api-reference/connectors/jobs/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Dispatch a job to a connector.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Timbal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Connector Job - Timbal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Dispatch a job to a connector.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Timbal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.timbal.ai/api-reference/connectors/jobs/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://timbaltechsl.mintlify.app/_mintlify/api/og/v2?division=Jobs\u0026amp;title=Create+Connector+Job\u0026amp;description=Dispatch+a+job+to+a+connector.\u0026amp;theme=259c386eb829de58cc6638f3\u0026amp;signature=a3a5523bc407a266baf2e1248f332dff68a6ec83781d7fa7b33e639bbe4a2d09\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Connector Job - Timbal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Dispatch a job to a connector.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://timbaltechsl.mintlify.app/_mintlify/api/og/v2?division=Jobs\u0026amp;title=Create+Connector+Job\u0026amp;description=Dispatch+a+job+to+a+connector.\u0026amp;theme=259c386eb829de58cc6638f3\u0026amp;signature=a3a5523bc407a266baf2e1248f332dff68a6ec83781d7fa7b33e639bbe4a2d09\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/timbaltechsl/HA5uMpfE6Se4k3W2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Timbal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.timbal.ai/api-reference/connectors/jobs/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/connectors/jobs/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.timbal.ai/#organization\",\"name\":\"Timbal\",\"url\":\"https://docs.timbal.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/timbaltechsl/pt3LfpScmY2Go19A/logo/light-small-1.svg?fit=max\u0026auto=format\u0026n=pt3LfpScmY2Go19A\u0026q=85\u0026s=fd26b0ce39e9e46d6dd08d81b611a9ea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.timbal.ai#website\",\"name\":\"Timbal\",\"url\":\"https://docs.timbal.ai\",\"publisher\":{\"@id\":\"https://docs.timbal.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create#webpage\",\"url\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create\",\"name\":\"Create Connector Job\",\"description\":\"Dispatch a job to a connector.\",\"dateModified\":\"2026-07-28T10:40:37.930Z\",\"isPartOf\":{\"@id\":\"https://docs.timbal.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connectors\",\"item\":\"https://docs.timbal.ai/api-reference/connectors/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Jobs\",\"item\":\"https://docs.timbal.ai/api-reference/connectors/jobs/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Connector Job\",\"item\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create#apireference\",\"headline\":\"Create Connector Job\",\"name\":\"Create Connector Job\",\"description\":\"Dispatch a job to a connector.\",\"url\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.timbal.ai/api-reference/connectors/jobs/create#webpage\"},\"dateModified\":\"2026-07-28T10:40:37.930Z\",\"publisher\":{\"@id\":\"https://docs.timbal.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.timbal.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Timbal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Timbal","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Upload file (temporary)","openapi":"POST /files","href":"/api-reference/files/upload"}]},{"group":"Me","pages":[{"title":"List Organizations","openapi":"GET /me/orgs","href":"/api-reference/me/list-orgs"},{"title":"Update Profile","openapi":"PATCH /me","href":"/api-reference/me/update"},{"group":"Profile Photo","pages":[{"title":"Upload Profile Photo","openapi":"PUT /me/photo","href":"/api-reference/me/photo/upload"},{"title":"Delete Profile Photo","openapi":"DELETE /me/photo","href":"/api-reference/me/photo/delete"}]},{"group":"API Tokens","pages":[{"title":"List API Tokens","openapi":"GET /me/tokens","href":"/api-reference/me/tokens/list"},{"title":"Create API Token","openapi":"POST /me/tokens","href":"/api-reference/me/tokens/create"},{"title":"Revoke API Token","openapi":"DELETE /me/tokens/{token_id}","href":"/api-reference/me/tokens/revoke"}]}]},{"group":"Organizations","pages":[{"title":"Create Organization","openapi":"POST /orgs","href":"/api-reference/orgs/create"},{"title":"Get Organization","openapi":"GET /orgs/{org_id}","href":"/api-reference/orgs/get"},{"title":"Update Organization","openapi":"PATCH /orgs/{org_id}","href":"/api-reference/orgs/update"},{"title":"List Account Contacts","openapi":"GET /orgs/{org_id}/contacts","href":"/api-reference/orgs/contacts/list"},{"title":"List Embedding Models","openapi":"GET /orgs/{org_id}/embedding-models","href":"/api-reference/orgs/embedding-models/list"},{"group":"Analytics","pages":[{"title":"Org Analytics — Costs","openapi":"GET /orgs/{org_id}/analytics/costs","href":"/api-reference/orgs/analytics/costs"},{"title":"Org Analytics — Usage","openapi":"GET /orgs/{org_id}/analytics/usage","href":"/api-reference/orgs/analytics/usage"},{"title":"Org Analytics — Users","openapi":"GET /orgs/{org_id}/analytics/users","href":"/api-reference/orgs/analytics/users"}]},{"group":"Billing","pages":[{"title":"Get Overage Summary","openapi":"GET /orgs/{org_id}/billing/overage","href":"/api-reference/orgs/billing/overage-summary"},{"title":"Update Overage Billing","openapi":"POST /orgs/{org_id}/billing/overage","href":"/api-reference/orgs/billing/overage"},{"title":"Get Credit Budgets","openapi":"GET /orgs/{org_id}/billing/budgets","href":"/api-reference/orgs/billing/budgets/get"},{"title":"Replace Credit Budgets","openapi":"PUT /orgs/{org_id}/billing/budgets","href":"/api-reference/orgs/billing/budgets/replace"},{"title":"Patch Credit Budgets","openapi":"PATCH /orgs/{org_id}/billing/budgets","href":"/api-reference/orgs/billing/budgets/patch"},{"title":"Get Compute Billing","openapi":"GET /orgs/{org_id}/billing/compute","href":"/api-reference/orgs/billing/compute/get"},{"title":"Set Compute Billing","openapi":"PUT /orgs/{org_id}/billing/compute","href":"/api-reference/orgs/billing/compute/put"}]},{"group":"Content","pages":[{"title":"Sign Content URL","openapi":"POST /orgs/{org_id}/content/sign","href":"/api-reference/orgs/content/sign"}]},{"group":"Organization Logo","pages":[{"title":"Upload Organization Logo","openapi":"PUT /orgs/{org_id}/photo","href":"/api-reference/orgs/photo/upload"},{"title":"Delete Organization Logo","openapi":"DELETE /orgs/{org_id}/photo","href":"/api-reference/orgs/photo/delete"}]},{"group":"Credit Grants","pages":[{"title":"List Credit Grants","openapi":"GET /orgs/{org_id}/credit-grants","href":"/api-reference/orgs/credit-grants/list"}]},{"group":"Model Policies","pages":[{"title":"List Model Policies","openapi":"GET /orgs/{org_id}/models/policies","href":"/api-reference/orgs/models/policies/list"},{"title":"Create Model Policy","openapi":"POST /orgs/{org_id}/models/policies","href":"/api-reference/orgs/models/policies/create"},{"title":"Delete Model Policy","openapi":"DELETE /orgs/{org_id}/models/policies/{policy_id}","href":"/api-reference/orgs/models/policies/delete"}]},{"group":"Templates","pages":[{"title":"List Templates","openapi":"GET /orgs/{org_id}/templates","href":"/api-reference/orgs/templates/list"}]},{"group":"Domains","pages":[{"title":"List Domains","openapi":"GET /orgs/{org_id}/domains","href":"/api-reference/orgs/domains/list"},{"title":"Create Domain","openapi":"POST /orgs/{org_id}/domains","href":"/api-reference/orgs/domains/create"},{"title":"Get Domain","openapi":"GET /orgs/{org_id}/domains/{domain_id}","href":"/api-reference/orgs/domains/get"},{"title":"Delete Domain","openapi":"DELETE /orgs/{org_id}/domains/{domain_id}","href":"/api-reference/orgs/domains/delete"}]},{"group":"IAM","pages":[{"title":"List IAM Actions","openapi":"GET /orgs/{org_id}/iam/actions","href":"/api-reference/orgs/iam/actions/list"},{"title":"List Users by Action","openapi":"GET /orgs/{org_id}/iam/actions/{action}/users","href":"/api-reference/orgs/iam/actions/users"},{"title":"List Users by Resource","openapi":"GET /orgs/{org_id}/iam/resources/{resource}/users","href":"/api-reference/orgs/iam/resources/users"},{"title":"Check IAM Permissions","openapi":"POST /orgs/{org_id}/iam/check","href":"/api-reference/orgs/iam/check"},{"group":"Roles","pages":[{"title":"List Organization Roles","openapi":"GET /orgs/{org_id}/iam/roles","href":"/api-reference/orgs/roles/list"},{"title":"Create Organization Role","openapi":"POST /orgs/{org_id}/iam/roles","href":"/api-reference/orgs/roles/create"},{"title":"Get Organization Role","openapi":"GET /orgs/{org_id}/iam/roles/{role_id}","href":"/api-reference/orgs/roles/get"},{"title":"Update Organization Role","openapi":"PATCH /orgs/{org_id}/iam/roles/{role_id}","href":"/api-reference/orgs/roles/update"},{"title":"Delete Organization Role","openapi":"DELETE /orgs/{org_id}/iam/roles/{role_id}","href":"/api-reference/orgs/roles/delete"}]},{"group":"Users","pages":[{"title":"List Users","openapi":"GET /orgs/{org_id}/iam/users","href":"/api-reference/orgs/users/list"},{"title":"Add User","openapi":"POST /orgs/{org_id}/iam/users","href":"/api-reference/orgs/users/add"},{"title":"Remove User","openapi":"DELETE /orgs/{org_id}/iam/users","href":"/api-reference/orgs/users/delete"},{"title":"Update User Roles","openapi":"PUT /orgs/{org_id}/iam/users/{user_id}/roles","href":"/api-reference/orgs/users/update"},{"title":"Batch Update User Roles","openapi":"PUT /orgs/{org_id}/iam/users/roles","href":"/api-reference/orgs/iam/users/batch-roles"},{"title":"Get User Effective Grants","openapi":"GET /orgs/{org_id}/iam/users/{user_id}/effective-grants","href":"/api-reference/orgs/iam/users/effective-grants"}]}]},{"group":"Identity Providers","pages":[{"title":"List Identity Providers","openapi":"GET /orgs/{org_id}/identity-providers","href":"/api-reference/orgs/identity-providers/list"},{"title":"Create Identity Provider","openapi":"POST /orgs/{org_id}/identity-providers","href":"/api-reference/orgs/identity-providers/create"},{"title":"Get a single SSO connection (secret masked)","openapi":"GET /orgs/{org_id}/identity-providers/{provider_id}","href":"/api-reference/orgs/identity-providers/get"},{"title":"Update Identity Provider","openapi":"PATCH /orgs/{org_id}/identity-providers/{provider_id}","href":"/api-reference/orgs/identity-providers/update"},{"title":"Delete an SSO connection (cascades to its group mappings)","openapi":"DELETE /orgs/{org_id}/identity-providers/{provider_id}","href":"/api-reference/orgs/identity-providers/delete"},{"title":"Default Role","openapi":"PUT /orgs/{org_id}/identity-providers/{provider_id}/default-role","href":"/api-reference/orgs/identity-providers/default-role"},{"title":"List external-group to role mappings for a connection","openapi":"GET /orgs/{org_id}/identity-providers/{provider_id}/group-mappings","href":"/api-reference/orgs/identity-providers/group-mappings/list"},{"title":"Map an external IdP group to a role for this connection","openapi":"POST /orgs/{org_id}/identity-providers/{provider_id}/group-mappings","href":"/api-reference/orgs/identity-providers/group-mappings/create"},{"title":"Delete a group-to-role mapping","openapi":"DELETE /orgs/{org_id}/identity-providers/{provider_id}/group-mappings/{mapping_id}","href":"/api-reference/orgs/identity-providers/group-mappings/delete"}]},{"group":"SCIM","pages":[{"title":"List SCIM Tokens","openapi":"GET /orgs/{org_id}/scim-tokens","href":"/api-reference/orgs/scim-tokens/list"},{"title":"Create SCIM Token","openapi":"POST /orgs/{org_id}/scim-tokens","href":"/api-reference/orgs/scim-tokens/create"},{"title":"Revoke SCIM Token","openapi":"DELETE /orgs/{org_id}/scim-tokens/{token_id}","href":"/api-reference/orgs/scim-tokens/revoke"}]}]},{"group":"Projects","pages":[{"title":"List Projects","openapi":"GET /orgs/{org_id}/projects","href":"/api-reference/projects/list"},{"title":"Create Project","openapi":"POST /orgs/{org_id}/projects","href":"/api-reference/projects/create"},{"title":"Get Project","openapi":"GET /orgs/{org_id}/projects/{project_id}","href":"/api-reference/projects/get"},{"title":"Update Project","openapi":"PATCH /orgs/{org_id}/projects/{project_id}","href":"/api-reference/projects/update"},{"title":"Delete Project","openapi":"DELETE /orgs/{org_id}/projects/{project_id}","href":"/api-reference/projects/delete"},{"title":"Duplicate Project","openapi":"POST /orgs/{org_id}/projects/{project_id}/duplicate","href":"/api-reference/projects/duplicate"},{"title":"Link Knowledge Base","openapi":"PUT /orgs/{org_id}/projects/{project_id}/k2","href":"/api-reference/projects/link-knowledge-base"},{"title":"Unlink Knowledge Base","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/k2","href":"/api-reference/projects/unlink-knowledge-base"},{"group":"App Auth","pages":[{"title":"Get App Auth Settings","openapi":"GET /orgs/{org_id}/projects/{project_id}/auth","href":"/api-reference/projects/auth/get"},{"title":"Update App Auth Settings","openapi":"PATCH /orgs/{org_id}/projects/{project_id}/auth","href":"/api-reference/projects/auth/update"},{"title":"Update Auth Provider","openapi":"PUT /orgs/{org_id}/projects/{project_id}/auth/providers/{provider}","href":"/api-reference/projects/auth/providers/update"}]},{"group":"Analytics","pages":[{"title":"Cost Analytics","openapi":"GET /orgs/{org_id}/projects/{project_id}/analytics/credits","href":"/api-reference/projects/analytics/credits"},{"title":"Usage Analytics","sidebarTitle":"General Analytics","openapi":"GET /orgs/{org_id}/projects/{project_id}/analytics/usage","href":"/api-reference/projects/analytics/usage"},{"title":"User Analytics","openapi":"GET /orgs/{org_id}/projects/{project_id}/analytics/users","href":"/api-reference/projects/analytics/users"}]},{"group":"Environments","pages":[{"title":"List Environments","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs","href":"/api-reference/projects/environments/list"},{"title":"Create Environment","openapi":"POST /orgs/{org_id}/projects/{project_id}/envs","href":"/api-reference/projects/environments/create"},{"title":"Delete Environment","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/envs/{env_id}","href":"/api-reference/projects/environments/delete"},{"title":"Update Branch","openapi":"PATCH /orgs/{org_id}/projects/{project_id}/envs/{env_id}/branch","href":"/api-reference/projects/environments/update-branch"},{"title":"Update Config","openapi":"PATCH /orgs/{org_id}/projects/{project_id}/envs/{env_id}/config","href":"/api-reference/projects/environments/update-config"},{"title":"Deploy","openapi":"POST /orgs/{org_id}/projects/{project_id}/envs/{env_id}/deploy","href":"/api-reference/projects/environments/deploy"},{"title":"Update Domain","openapi":"PATCH /orgs/{org_id}/projects/{project_id}/envs/{env_id}/domain","href":"/api-reference/projects/environments/update-domain"},{"title":"Get Metrics","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/metrics/{metric_type}","href":"/api-reference/projects/environments/get-metrics"},{"title":"Stop","openapi":"POST /orgs/{org_id}/projects/{project_id}/envs/{env_id}/stop","href":"/api-reference/projects/environments/stop"},{"title":"List Environment Deployments","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments","href":"/api-reference/projects/environments/deployments/list"},{"title":"Get Environment Logs","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/logs","href":"/api-reference/projects/environments/logs"}]},{"group":"Runs","pages":[{"title":"List Runs","openapi":"GET /orgs/{org_id}/projects/{project_id}/runs","href":"/api-reference/projects/runs/list"},{"title":"Get Run","openapi":"GET /orgs/{org_id}/projects/{project_id}/runs/{run_id}","href":"/api-reference/projects/runs/get"},{"title":"List Reactions","openapi":"GET /orgs/{org_id}/projects/{project_id}/runs/{run_id}/reactions","href":"/api-reference/projects/runs/reactions-list"},{"title":"Add Reaction","openapi":"POST /orgs/{org_id}/projects/{project_id}/runs/{run_id}/reactions","href":"/api-reference/projects/runs/reactions-add"}]},{"group":"Variables","pages":[{"title":"List Variables","openapi":"GET /orgs/{org_id}/projects/{project_id}/vars","href":"/api-reference/projects/vars/list"},{"title":"Create Variable","openapi":"POST /orgs/{org_id}/projects/{project_id}/vars","href":"/api-reference/projects/vars/create"},{"title":"Batch Create Variables","openapi":"POST /orgs/{org_id}/projects/{project_id}/vars/batch","href":"/api-reference/projects/vars/batch-create"},{"title":"Get Variable","openapi":"GET /orgs/{org_id}/projects/{project_id}/vars/{var_id}","href":"/api-reference/projects/vars/get"},{"title":"Delete Variable","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/vars/{var_id}","href":"/api-reference/projects/vars/delete"},{"title":"Update Variable","openapi":"PATCH /orgs/{org_id}/projects/{project_id}/vars/{var_id}","href":"/api-reference/projects/vars/update"}]},{"group":"Channels","pages":[{"title":"Upsert Channel","openapi":"PUT /orgs/{org_id}/projects/{project_id}/channels/{workforce}/{provider}","href":"/api-reference/projects/channels/put"},{"title":"Delete Channel","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/channels/{workforce}/{provider}","href":"/api-reference/projects/channels/delete"}]},{"group":"Workforce","pages":[{"title":"List Workforce","openapi":"GET /orgs/{org_id}/projects/{project_id}/workforce","href":"/api-reference/projects/workforce/list"},{"title":"Create Workforce","openapi":"POST /orgs/{org_id}/projects/{project_id}/workforce","href":"/api-reference/projects/workforce/create"},{"title":"Delete Workforce","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/workforce","href":"/api-reference/projects/workforce/delete"},{"title":"Call Workforce","openapi":"POST /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/{*path}","href":"/api-reference/projects/workforce/call"},{"title":"Call Workforce (GET)","openapi":"GET /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/{*path}","href":"/api-reference/projects/workforce/call-get"},{"title":"Call Workforce (PUT)","openapi":"PUT /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/{*path}","href":"/api-reference/projects/workforce/call-put"},{"title":"Call Workforce (PATCH)","openapi":"PATCH /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/{*path}","href":"/api-reference/projects/workforce/call-patch"},{"title":"Call Workforce (DELETE)","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/{*path}","href":"/api-reference/projects/workforce/call-delete"}]}]},{"group":"Knowledge Bases","pages":[{"title":"List Knowledge Bases","openapi":"GET /orgs/{org_id}/k2","href":"/api-reference/knowledge-bases/list"},{"title":"Create Knowledge Base","openapi":"POST /orgs/{org_id}/k2","href":"/api-reference/knowledge-bases/create"},{"title":"Get Knowledge Base","openapi":"GET /orgs/{org_id}/k2/{kb_id}","href":"/api-reference/knowledge-bases/get"},{"title":"Edit Knowledge Base","openapi":"PATCH /orgs/{org_id}/k2/{kb_id}","href":"/api-reference/knowledge-bases/update"},{"title":"Delete Knowledge Base","openapi":"DELETE /orgs/{org_id}/k2/{kb_id}","href":"/api-reference/knowledge-bases/delete"},{"title":"Query","openapi":"POST /orgs/{org_id}/k2/{kb_id}/query","href":"/api-reference/knowledge-bases/query"},{"title":"Get Schema","openapi":"GET /orgs/{org_id}/k2/{kb_id}/schema","href":"/api-reference/knowledge-bases/schema"},{"title":"Upload Data","openapi":"POST /orgs/{org_id}/k2/{kb_id}/upload","href":"/api-reference/knowledge-bases/upload"},{"group":"Policies","pages":[{"title":"List Policies","openapi":"GET /orgs/{org_id}/k2/{kb_id}/policies","href":"/api-reference/knowledge-bases/policies/list"},{"title":"Create Policy","openapi":"POST /orgs/{org_id}/k2/{kb_id}/policies","href":"/api-reference/knowledge-bases/policies/create"},{"title":"Get Policy","openapi":"GET /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}","href":"/api-reference/knowledge-bases/policies/get"},{"title":"Update Policy","openapi":"PATCH /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}","href":"/api-reference/knowledge-bases/policies/update"},{"title":"Delete Policy","openapi":"DELETE /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}","href":"/api-reference/knowledge-bases/policies/delete"},{"title":"Set Governance Mode","openapi":"PUT /orgs/{org_id}/k2/{kb_id}/policies/governance-mode","href":"/api-reference/knowledge-bases/policies/governance-mode"},{"group":"Assignments","pages":[{"title":"List Policy Assignments","openapi":"GET /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}/assignments","href":"/api-reference/knowledge-bases/policies/assignments/list"},{"title":"Create Policy Assignment","openapi":"POST /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}/assignments","href":"/api-reference/knowledge-bases/policies/assignments/create"},{"title":"Get Policy Assignment","openapi":"GET /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}/assignments/{assignment_id}","href":"/api-reference/knowledge-bases/policies/assignments/get"},{"title":"Delete Policy Assignment","openapi":"DELETE /orgs/{org_id}/k2/{kb_id}/policies/{policy_id}/assignments/{assignment_id}","href":"/api-reference/knowledge-bases/policies/assignments/delete"}]}]},{"group":"Backups","pages":[{"title":"List Backups","openapi":"GET /orgs/{org_id}/k2/{kb_id}/backups","href":"/api-reference/knowledge-bases/backups/list"},{"title":"Create Backup","openapi":"POST /orgs/{org_id}/k2/{kb_id}/backups","href":"/api-reference/knowledge-bases/backups/create"},{"title":"Get Backup","openapi":"GET /orgs/{org_id}/k2/{kb_id}/backups/{backup_id}","href":"/api-reference/knowledge-bases/backups/get"},{"title":"List Restores","openapi":"GET /orgs/{org_id}/k2/{kb_id}/restores","href":"/api-reference/knowledge-bases/restores/list"},{"title":"Restore","openapi":"POST /orgs/{org_id}/k2/{kb_id}/restores","href":"/api-reference/knowledge-bases/restores/create"},{"title":"Get Restore","openapi":"GET /orgs/{org_id}/k2/{kb_id}/restores/{restore_id}","href":"/api-reference/knowledge-bases/restores/get"}]},{"group":"Files","pages":[{"title":"List Files","openapi":"GET /orgs/{org_id}/k2/{kb_id}/files","href":"/api-reference/knowledge-bases/files/list"},{"title":"Add File","openapi":"POST /orgs/{org_id}/k2/{kb_id}/files","href":"/api-reference/knowledge-bases/files/add"},{"title":"Create Directory","openapi":"POST /orgs/{org_id}/k2/{kb_id}/directories","href":"/api-reference/knowledge-bases/files/create-dir"},{"title":"Get File","openapi":"GET /orgs/{org_id}/k2/{kb_id}/files/{file_id}","href":"/api-reference/knowledge-bases/files/get"},{"title":"Delete File","openapi":"DELETE /orgs/{org_id}/k2/{kb_id}/files/{file_id}","href":"/api-reference/knowledge-bases/files/delete"},{"group":"Chunks","pages":[{"title":"List Chunks","openapi":"GET /orgs/{org_id}/k2/{kb_id}/files/{file_id}/chunks","href":"/api-reference/knowledge-bases/files/chunks/list"},{"title":"Insert Chunk","openapi":"POST /orgs/{org_id}/k2/{kb_id}/files/{file_id}/chunks","href":"/api-reference/knowledge-bases/files/chunks/insert"},{"title":"Get Chunk","openapi":"GET /orgs/{org_id}/k2/{kb_id}/files/{file_id}/chunks/{chunk_uid}","href":"/api-reference/knowledge-bases/files/chunks/get"},{"title":"Update Chunk","openapi":"PATCH /orgs/{org_id}/k2/{kb_id}/files/{file_id}/chunks/{chunk_uid}","href":"/api-reference/knowledge-bases/files/chunks/update"},{"title":"Delete Chunk","openapi":"DELETE /orgs/{org_id}/k2/{kb_id}/files/{file_id}/chunks/{chunk_uid}","href":"/api-reference/knowledge-bases/files/chunks/delete"}]}]}]},{"group":"Evals","pages":[{"title":"List Eval Definitions","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/definitions","href":"/api-reference/evals/definitions"},{"group":"Jobs","pages":[{"title":"List Eval Jobs","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/jobs","href":"/api-reference/evals/jobs/list"},{"title":"Get Eval Job","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/jobs/{job_uid}","href":"/api-reference/evals/jobs/get"},{"title":"Create Eval Job","openapi":"POST /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/jobs","href":"/api-reference/evals/jobs/create"}]},{"group":"Runs","pages":[{"title":"List Eval Runs","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/runs","href":"/api-reference/evals/runs/list"},{"title":"Get Eval Run","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/runs/{eval_run_id}","href":"/api-reference/evals/runs/get"},{"title":"Stream Eval Run Events","openapi":"GET /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/runs/{eval_run_id}/events","href":"/api-reference/evals/runs/events"},{"title":"Create Eval Run","openapi":"POST /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/runs","href":"/api-reference/evals/runs/create"},{"title":"Delete Eval Run","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/envs/{env_id}/evals/runs/{eval_run_id}","href":"/api-reference/evals/runs/delete"}]}]},{"group":"ACE","tag":"Pro","pages":[{"title":"Create from Agent","openapi":"POST /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/ace","href":"/api-reference/ace/create-from-workforce"},{"title":"Link to Agent","openapi":"PUT /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/ace","href":"/api-reference/ace/link"},{"title":"Unlink from Agent","openapi":"DELETE /orgs/{org_id}/projects/{project_id}/workforce/{workforce}/ace","href":"/api-reference/ace/unlink"},{"title":"List Policies","openapi":"GET /ace/{ace_uid}/policies","href":"/api-reference/ace/list-policies"},{"title":"List Context Variables","openapi":"GET /ace/{ace_uid}/vars","href":"/api-reference/ace/list-context-vars"},{"title":"Chat Completions","openapi":"POST /ace/{ace_uid}/v1/chat/completions","href":"/api-reference/ace/chat-completions"},{"group":"Jobs","pages":[{"title":"List Jobs","openapi":"GET /ace/{ace_uid}/jobs","href":"/api-reference/ace/jobs/list"},{"title":"Enqueue Job","openapi":"POST /ace/{ace_uid}/jobs","href":"/api-reference/ace/jobs/create"},{"title":"Get Job","openapi":"GET /ace/{ace_uid}/jobs/{job_uid}","href":"/api-reference/ace/jobs/get"},{"title":"Cancel Job","openapi":"POST /ace/{ace_uid}/jobs/{job_uid}/cancel","href":"/api-reference/ace/jobs/cancel"},{"title":"Retry Job","openapi":"POST /ace/{ace_uid}/jobs/{job_uid}/retry","href":"/api-reference/ace/jobs/retry"}]}]},{"group":"Alarms","pages":[{"title":"List Alarms","openapi":"GET /orgs/{org_id}/alarms","href":"/api-reference/alarms/list"},{"title":"Create Alarm","openapi":"POST /orgs/{org_id}/alarms","href":"/api-reference/alarms/create"},{"title":"Get Alarm","openapi":"GET /orgs/{org_id}/alarms/{alarm_id}","href":"/api-reference/alarms/get"},{"title":"Update Alarm","openapi":"PATCH /orgs/{org_id}/alarms/{alarm_id}","href":"/api-reference/alarms/update"},{"title":"Delete Alarm","openapi":"DELETE /orgs/{org_id}/alarms/{alarm_id}","href":"/api-reference/alarms/delete"},{"title":"Alarms Health","openapi":"GET /orgs/{org_id}/alarms/health","href":"/api-reference/alarms/health"},{"title":"Alarm History","openapi":"GET /orgs/{org_id}/alarms/{alarm_id}/history","href":"/api-reference/alarms/history"},{"title":"Attach Channel to Alarm","openapi":"POST /orgs/{org_id}/alarms/{alarm_id}/channels","href":"/api-reference/alarms/attach-channel"},{"title":"Detach Channel from Alarm","openapi":"DELETE /orgs/{org_id}/alarms/{alarm_id}/channels/{channel_id}","href":"/api-reference/alarms/detach-channel"},{"group":"Channels","pages":[{"title":"List Channels","openapi":"GET /orgs/{org_id}/channels","href":"/api-reference/alarms/channels/list"},{"title":"Create Channel","openapi":"POST /orgs/{org_id}/channels","href":"/api-reference/alarms/channels/create"},{"title":"Delete Channel","openapi":"DELETE /orgs/{org_id}/channels/{channel_id}","href":"/api-reference/alarms/channels/delete"}]},{"group":"Metrics","pages":[{"title":"Query Metric","openapi":"GET /orgs/{org_id}/metrics","href":"/api-reference/alarms/metrics/query"},{"title":"Metrics Catalog","openapi":"GET /orgs/{org_id}/metrics/catalog","href":"/api-reference/alarms/metrics/catalog"},{"group":"Definitions","pages":[{"title":"List Metric Definitions","openapi":"GET /orgs/{org_id}/metrics/definitions","href":"/api-reference/alarms/metrics/definitions/list"},{"title":"Create Metric Definition","openapi":"POST /orgs/{org_id}/metrics/definitions","href":"/api-reference/alarms/metrics/definitions/create"},{"title":"Preview Metric Definition","openapi":"POST /orgs/{org_id}/metrics/definitions/preview","href":"/api-reference/alarms/metrics/definitions/preview"},{"title":"Update Metric Definition","openapi":"PATCH /orgs/{org_id}/metrics/definitions/{definition_id}","href":"/api-reference/alarms/metrics/definitions/update"},{"title":"Delete Metric Definition","openapi":"DELETE /orgs/{org_id}/metrics/definitions/{definition_id}","href":"/api-reference/alarms/metrics/definitions/delete"}]}]}]},{"group":"Connectors","pages":[{"title":"List Connectors","openapi":"GET /orgs/{org_id}/connectors","href":"/api-reference/connectors/list"},{"title":"Get Connector","openapi":"GET /orgs/{org_id}/connectors/{connector_id}","href":"/api-reference/connectors/get"},{"title":"Update Connector","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/update","href":"/api-reference/connectors/update"},{"title":"Push Local Config","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/local-config","href":"/api-reference/connectors/local-config"},{"title":"Query Connector","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/query","href":"/api-reference/connectors/query"},{"title":"Rebind Connector","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/rebind","href":"/api-reference/connectors/rebind"},{"title":"Revoke Connector","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/revoke","href":"/api-reference/connectors/revoke"},{"title":"Copy Filesystem to Knowledge Base","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/filesystems/copy","href":"/api-reference/connectors/filesystems/copy"},{"group":"Enrollment Tokens","pages":[{"title":"Create Enrollment Token","openapi":"POST /orgs/{org_id}/connectors/enrollment-tokens","href":"/api-reference/connectors/enrollment-tokens/create"}]},{"group":"Jobs","pages":[{"title":"List Connector Jobs","openapi":"GET /orgs/{org_id}/connectors/jobs","description":"List connector jobs for the organization.","href":"/api-reference/connectors/jobs/list"},{"title":"Create Connector Job","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/jobs","href":"/api-reference/connectors/jobs/create"},{"title":"Stop Connector Job","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/jobs/{job_id}/stop","description":"Cancel a running extract job. The row is terminalized as `stopped` first\n(so the run is dead even if the connector is offline or never acks), then a\n`StopJob` command aborts the connector-side task best-effort. Idempotent:\nstopping an already-terminal job returns its current state.","href":"/api-reference/connectors/jobs/stop"}]},{"group":"Syncs","pages":[{"title":"List Connector Syncs","openapi":"GET /orgs/{org_id}/connectors/syncs","href":"/api-reference/connectors/syncs/list"},{"title":"Create Connector Sync","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/syncs","href":"/api-reference/connectors/syncs/create"},{"title":"Get Connector Sync","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}","href":"/api-reference/connectors/syncs/get"},{"title":"Update Connector Sync","openapi":"PATCH /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}","href":"/api-reference/connectors/syncs/update"},{"title":"Delete Connector Sync","openapi":"DELETE /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}","href":"/api-reference/connectors/syncs/delete"},{"title":"Run Sync Now","openapi":"POST /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}/run","href":"/api-reference/connectors/syncs/run"}]},{"group":"Browse","pages":[{"title":"Browse Connections","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/connections","href":"/api-reference/connectors/browse/connections"},{"title":"Browse Tables","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/tables","href":"/api-reference/connectors/browse/tables"},{"title":"Browse Table","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/table","href":"/api-reference/connectors/browse/table"},{"title":"Browse Columns","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/columns","href":"/api-reference/connectors/browse/columns"},{"group":"Filesystems","pages":[{"title":"List Filesystems","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/filesystems","href":"/api-reference/connectors/browse/filesystems/list"},{"title":"List Filesystem Entries","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/filesystems/entries","href":"/api-reference/connectors/browse/filesystems/entries"},{"title":"Search Filesystem","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/filesystems/search","href":"/api-reference/connectors/browse/filesystems/search"},{"title":"Summarize Filesystem","openapi":"GET /orgs/{org_id}/connectors/{connector_id}/browse/filesystems/summary","href":"/api-reference/connectors/browse/filesystems/summary"}]}]}]}]},{"tab":"Model Reference","pages":[{"title":"Model Reference","href":"/models/overview"}]},{"tab":"MCP Integration","pages":[{"title":"MCP Integration","href":"/mcp-integration"}]}]},"title":"Create Connector Job - Timbal","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}