The Timbal API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.Projects have environments for deployment configuration, including environment variables and deployed revisions. Use separate environments for development, staging, and production. Knowledge bases are separate organization resources; project deployment versions do not automatically version their data.
Most resources in Timbal are scoped to an organization, meaning their API path is prefixed with /orgs/{org_id}. Resources are then nested under their parent in a standard RESTful hierarchy. For example:
/orgs/{org_id}/projects/orgs/{org_id}/projects/{project_id}/envs/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deploy/orgs/{org_id}/k2/{kb_id}/query # knowledge bases; the path segment is k2
Not all endpoints are org-scoped. Some are user-scoped and live under /me (e.g. listing organizations or managing API keys). POST /files uploads a short-lived binary to object storage (Bearer auth, same as the rest of the API); it does not include org_id in the path—org context comes from the authenticated key.
HTTP verbs follow REST conventions:
Verb
Usage
GET
Retrieve a resource or list
POST
Create a resource or start an action
PUT
Replace a resource
PATCH
Partially update a resource
DELETE
Delete a resource
{"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":"6ae231c7fdcdc020a5fca4a3","collectionId":"8adbc99a-3b4b-43e6-8b0b-20828dd5e854","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae231c7fdcdc020a5fca4a3"},"entitlements":{},"buildId":"6ae231c7fdcdc020a5fca4a3","clientVersion":"0.0.4054","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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"Introduction to the Timbal Platform API","href":"/api-reference/introduction"},"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: \"Introduction to the Timbal Platform API\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The Timbal API is organized around `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/REST`,children:`REST`}),`. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.`]}),`\n`,_jsx(_components.p,{children:`Projects have environments for deployment configuration, including environment variables and deployed revisions. Use separate environments for development, staging, and production. Knowledge bases are separate organization resources; project deployment versions do not automatically version their data.`}),`\n`,_jsx(Heading,{level:`2`,id:`organization-scoping`,children:`Organization scoping`}),`\n`,_jsxs(_components.p,{children:[`Most resources in Timbal are scoped to an `,_jsx(_components.strong,{children:`organization`}),`, meaning their API path is prefixed with `,_jsx(_components.code,{children:`/orgs/{org_id}`}),`. Resources are then nested under their parent in a standard RESTful hierarchy. For example:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`5`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`/orgs/{org_id}/projects`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`/orgs/{org_id}/projects/{project_id}/envs`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deploy`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`/orgs/{org_id}/k2/{kb_id}/query # knowledge bases; the path segment is k2`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Not all endpoints are org-scoped. Some are user-scoped and live under `,_jsx(_components.code,{children:`/me`}),` (e.g. listing organizations or managing API keys). `,_jsx(_components.strong,{children:_jsx(_components.code,{children:`POST /files`})}),` uploads a short-lived binary to object storage (Bearer auth, same as the rest of the API); it does `,_jsx(_components.strong,{children:`not`}),` include `,_jsx(_components.code,{children:`org_id`}),` in the path—org context comes from the authenticated key.`]})}),`\n`,_jsx(_components.p,{children:`HTTP verbs follow REST conventions:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Verb`}),_jsx(_components.th,{children:`Usage`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:`Retrieve a resource or list`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST`})}),_jsx(_components.td,{children:`Create a resource or start an action`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PUT`})}),_jsx(_components.td,{children:`Replace a resource`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PATCH`})}),_jsx(_components.td,{children:`Partially update a resource`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DELETE`})}),_jsx(_components.td,{children:`Delete a resource`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Introduction","description":"Introduction to the Timbal Platform API","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Organization scoping","slug":"organization-scoping","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"timbaltechsl","siteName":"Timbal","title":"Introduction - Timbal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T13:57:13.138Z","originalFileLocation":"api-reference/introduction.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=\"Introduction to the Timbal Platform API\">\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=\"Introduction - Timbal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Introduction to the Timbal Platform API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Timbal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.timbal.ai/api-reference/introduction\">\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=API+Documentation\u0026amp;title=Introduction\u0026amp;description=Introduction+to+the+Timbal+Platform+API\u0026amp;theme=259c386eb829de58cc6638f3\u0026amp;signature=4724f7e8072aae89332af46e9f1682c8da55143aff1e993ea158bacac898b87a\">\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=\"Introduction - Timbal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Introduction to the Timbal Platform API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://timbaltechsl.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=Introduction+to+the+Timbal+Platform+API\u0026amp;theme=259c386eb829de58cc6638f3\u0026amp;signature=4724f7e8072aae89332af46e9f1682c8da55143aff1e993ea158bacac898b87a\">\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/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.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/introduction#webpage\",\"url\":\"https://docs.timbal.ai/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"Introduction to the Timbal Platform API\",\"dateModified\":\"2026-10-28T13:57:13.138Z\",\"isPartOf\":{\"@id\":\"https://docs.timbal.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.timbal.ai/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.timbal.ai/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Timbal\",\"item\":\"https://docs.timbal.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.timbal.ai/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.timbal.ai/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Introduction to the Timbal Platform API\",\"url\":\"https://docs.timbal.ai/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.timbal.ai/api-reference/introduction#webpage\"},\"dateModified\":\"2026-10-28T13:57:13.138Z\",\"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","description":"How to authenticate to the Timbal API","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","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","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"}]}]},"basePath":"","title":"Introduction - Timbal","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":[],"chunks":[]}
