Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already cancelling or cancelled is returned unchanged.
LLM model to use for every item in the batch. Model availability is cloud-aware: AWS teamspaces accept Bedrock-native batch-capable models, while GCP teamspaces accept non-Bedrock batch-capable models and reject Bedrock-only ids. Deprecated gemini-2.x-flash ids are accepted for backward compatibility and automatically run as gemini-3.1-flash-lite.
Relative URL for the NDJSON results stream once the batch is terminal. This becomes null after retained result lines are cleaned up.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Datagrid AI","colors":{"primary":"#000000","light":"#ffbc4d","dark":"#ffbc4d"},"logo":{"light":"https://mintcdn.com/datagrid/3IQk8fJ69KvSFDfU/images/datagrid-logo-light.svg?fit=max\u0026auto=format\u0026n=3IQk8fJ69KvSFDfU\u0026q=85\u0026s=c4274428e9b371bf09005fa9db0ed804","dark":"https://mintcdn.com/datagrid/3IQk8fJ69KvSFDfU/images/datagrid-logo-dark.svg?fit=max\u0026auto=format\u0026n=3IQk8fJ69KvSFDfU\u0026q=85\u0026s=2ef6295f04b1f337c487f26665adc131","href":"https://datagrid.com/"},"favicon":"https://mintcdn.com/datagrid/3IQk8fJ69KvSFDfU/favicon.svg?fit=max\u0026auto=format\u0026n=3IQk8fJ69KvSFDfU\u0026q=85\u0026s=347899b9390b1be995b97d69e8f3e053","api":{"openapi":"datagrid-ai-open-api.yaml","playground":{"display":"interactive"},"examples":{"languages":["python","javascript","bash"]},"mdx":{"server":"https://api.datagrid.com"}},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:support@datagrid.com","label":"Support"}],"primary":{"type":"button","label":"Get your API Key","href":"https://app.datagrid.com/chats?at=chats\u0026st=api_keys\u0026redirect_url=chats?at=chats%26st=api_keys"}},"footer":{"socials":{"github":"https://github.com/DatagridAI","linkedin":"https://linkedin.com/company/Datagrid-AI","slack":"https://join.slack.com/t/datagrid-users/shared_invite/zt-2tl2omd78-qO8zHN5_sK39_lRsyZA4Dg"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Get your API Key","icon":"code","href":"https://app.datagrid.com/chats?at=chats\u0026st=api_keys\u0026redirect_url=chats?at=chats%26st=api_keys"},{"anchor":"Join us on Slack","icon":"slack","href":"https://join.slack.com/t/datagrid-users/shared_invite/zt-2tl2omd78-qO8zHN5_sK39_lRsyZA4Dg"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"datagrid","hasAudioNarration":false,"actualSubdomain":"datagrid","customDomains":["developers.datagrid.com"],"gitSource":{"type":"github","owner":"toriclabs","repo":"main","deployBranch":"mintlify-prod-docs","contentDirectory":"docs/datagrid-ai","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae89ac9a8708698b47ba595","collectionId":"5cb2f133-d5a6-4c2b-b1ca-c856ef3f6ca4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae89ac9a8708698b47ba595"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae90962cf2b549b4312c4c8","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":175},{"language":"default","tag":"Knowledge","count":20},{"language":"default","tag":"Organization","count":19},{"language":"default","tag":"Channels","count":16},{"language":"default","tag":"Skills","count":12},{"language":"default","tag":"Agents","count":9},{"language":"default","tag":"Converse","count":8},{"language":"default","tag":"MCP Servers - Beta","count":8},{"language":"default","tag":"Batch Predictions","count":7},{"language":"default","tag":"Data Views","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".token{text-wrap:auto}"}],"page":{"pagePath":"api-reference/batch-predictions/cancel-batch-prediction","slug":"/api-reference/batch-predictions/cancel-batch-prediction","pageMetadata":{"openapi":"post /batch-predictions/{batch_prediction_id}/cancel","title":"Cancel batch prediction","description":"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already `cancelling` or `cancelled` is returned unchanged.","href":"/api-reference/batch-predictions/cancel-batch-prediction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already \", _jsx(_components.code, {\n children: \"cancelling\"\n }), \" or \", _jsx(_components.code, {\n children: \"cancelled\"\n }), \" is returned unchanged.\"]\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":{"config":{},"pageMetadata":{"openapi":"post /batch-predictions/{batch_prediction_id}/cancel","title":"Cancel batch prediction","description":"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already `cancelling` or `cancelled` is returned unchanged.","href":"/api-reference/batch-predictions/cancel-batch-prediction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/datagrid/63000a1b04510866/tools/jest.config.js"],"openApiReferenceData":{"operation":{"summary":"Cancel batch prediction","operationId":"BatchPredictions.cancelBatchPrediction","description":"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already `cancelling` or `cancelled` is returned unchanged.","tags":["Batch Predictions"],"parameters":["5b07fc05-f7c6-4186-85b2-266099e12093"],"responses":{"200":"2e76ee56-8128-4315-89c8-d8acd59ac448","401":"c0d4500a-0a05-43f4-acfe-eadee2bed1e7","404":"93668ada-a2de-469b-b1fd-af1bb278ed29","409":"7e17831d-ec30-433f-b070-61da79373abe","429":"630a1eee-0912-468d-b26c-a96fb441f00e"},"method":"post","type":"path","servers":["76432f4e-9b5f-489c-85af-ee9c79f08c03"],"security":["d9502149-5635-4363-bc2e-7245d0c5f680"],"path":"/batch-predictions/{batch_prediction_id}/cancel","baseUrlOptions":["https://api.datagrid.com/v1"],"title":"Cancel batch prediction","codeSamples":[],"requestExampleLanguages":["python","javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5b07fc05-f7c6-4186-85b2-266099e12093":{"name":"batch_prediction_id","in":"path","required":true,"description":"The id of the batch prediction to cancel.","schema":{"type":"string","isRequired":true,"description":"The id of the batch prediction to cancel.","uniqueKey":"","typeLabel":"string"}}},"responses":{"2e76ee56-8128-4315-89c8-d8acd59ac448":{"description":"Cancelled or cancelling batch prediction","headers":{"X-Request-Id":{"description":"Request identifier for tracing and support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"The `batch_prediction` object represents an asynchronous batch prediction job.","required":["object","id","status","model","completion_window","created_at","expires_at","in_progress_at","finalizing_at","completed_at","failed_at","cancelling_at","cancelled_at","expired_at","request_counts","metadata","error","results_url"],"properties":{"object":{"type":"string","enum":["batch_prediction"],"description":"The object type, which is always `batch_prediction`.","isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the batch prediction.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","description":"Current batch lifecycle state. Terminal states are `completed`, `failed`, `expired`, and `cancelled`.","enum":["validating","failed","in_progress","finalizing","completed","expired","cancelling","cancelled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"LLM model to use for every item in the batch. Model availability is cloud-aware: AWS teamspaces accept Bedrock-native batch-capable models, while GCP teamspaces accept non-Bedrock batch-capable models and reject Bedrock-only ids. Deprecated gemini-2.x-flash ids are accepted for backward compatibility and automatically run as gemini-3.1-flash-lite.","enum":["gemini-2.0-flash","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-3.1-flash-lite","gemini-3.5-flash","gemini-3.8-flash","gemini-2.5-pro","gemini-3.1-pro-preview","gpt-4o","gpt-4o-mini","gpt-4.1-mini","gpt-4.1","gpt-5-mini","gpt-5","gpt-5.1","claude-sonnet-4@20250514","claude-opus-4-1@20250805","claude-haiku-4-5@20251001","claude-sonnet-4-5@20250929","claude-sonnet-4-6@default","claude-opus-4-5@20251101","claude-opus-4-6@default","claude-opus-4-7","claude-opus-4-8","anthropic.claude-haiku-4-5-20251001-v1:0","anthropic.claude-sonnet-4-5-20250929-v1:0","anthropic.claude-sonnet-4-6","anthropic.claude-opus-4-5-20251101-v1:0","anthropic.claude-opus-4-6-v1","anthropic.claude-opus-4-7","anthropic.claude-opus-4-8","amazon.nova-2-lite-v1:0"],"isRequired":true,"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"completion_window":{"type":"string","enum":["24h"],"description":"Requested completion window.","isRequired":true,"uniqueKey":"completion_window","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"ISO timestamp when the batch was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","description":"ISO timestamp when the batch completion window expires.","isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"in_progress_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when the batch entered `in_progress`, or `null` if it has not.","isRequired":true,"uniqueKey":"in_progress_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when the batch entered `in_progress`, or `null` if it has not.","isRequired":true,"uniqueKey":"in_progress_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"in_progress_at","typeLabel":"string\u003cdate-time> | null"},"finalizing_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when the batch entered `finalizing`, or `null` if it has not.","isRequired":true,"uniqueKey":"finalizing_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when the batch entered `finalizing`, or `null` if it has not.","isRequired":true,"uniqueKey":"finalizing_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"finalizing_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when the batch reached `completed`, or `null` otherwise.","isRequired":true,"uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when the batch reached `completed`, or `null` otherwise.","isRequired":true,"uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"failed_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when the batch reached `failed`, or `null` otherwise.","isRequired":true,"uniqueKey":"failed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when the batch reached `failed`, or `null` otherwise.","isRequired":true,"uniqueKey":"failed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"failed_at","typeLabel":"string\u003cdate-time> | null"},"cancelling_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when cancellation was requested, or `null` otherwise.","isRequired":true,"uniqueKey":"cancelling_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when cancellation was requested, or `null` otherwise.","isRequired":true,"uniqueKey":"cancelling_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cancelling_at","typeLabel":"string\u003cdate-time> | null"},"cancelled_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when the batch reached `cancelled`, or `null` otherwise.","isRequired":true,"uniqueKey":"cancelled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when the batch reached `cancelled`, or `null` otherwise.","isRequired":true,"uniqueKey":"cancelled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cancelled_at","typeLabel":"string\u003cdate-time> | null"},"expired_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO timestamp when the batch reached `expired`, or `null` otherwise.","isRequired":true,"uniqueKey":"expired_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO timestamp when the batch reached `expired`, or `null` otherwise.","isRequired":true,"uniqueKey":"expired_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expired_at","typeLabel":"string\u003cdate-time> | null"},"request_counts":{"type":"object","required":["total","processing","succeeded","errored","canceled","expired"],"properties":{"total":{"type":"integer","minimum":0,"description":"Total number of submitted items.","isRequired":true,"uniqueKey":"request_counts.total","typeLabel":"integer"},"processing":{"type":"integer","minimum":0,"description":"Items that are still pending or processing.","isRequired":true,"uniqueKey":"request_counts.processing","typeLabel":"integer"},"succeeded":{"type":"integer","minimum":0,"description":"Items that completed with a valid output.","isRequired":true,"uniqueKey":"request_counts.succeeded","typeLabel":"integer"},"errored":{"type":"integer","minimum":0,"description":"Items that ended with an error.","isRequired":true,"uniqueKey":"request_counts.errored","typeLabel":"integer"},"canceled":{"type":"integer","minimum":0,"description":"Items that were cancelled before completion.","isRequired":true,"uniqueKey":"request_counts.canceled","typeLabel":"integer"},"expired":{"type":"integer","minimum":0,"description":"Items that did not finish before the completion window elapsed.","isRequired":true,"uniqueKey":"request_counts.expired","typeLabel":"integer"}},"description":"The sum of processing, succeeded, errored, canceled, and expired equals total.","isRequired":true,"uniqueKey":"request_counts","typeLabel":"object"},"metadata":{"oneOf":[{"type":"object","description":"Optional metadata map with up to 16 entries. Metadata keys must be 64 characters or fewer and values must be 512 characters or fewer.","maxProperties":16,"additionalProperties":{"type":"string","maxLength":512,"uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional metadata map with up to 16 entries. Metadata keys must be 64 characters or fewer and values must be 512 characters or fewer.","maxProperties":16,"additionalProperties":{"type":"string","maxLength":512,"uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"metadata","typeLabel":"object | null"},"error":{"oneOf":[{"type":"object","description":"Batch-level terminal error details for `failed`, `cancelled`, or `expired` batches; otherwise `null`.","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.oneOf.0.type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"error.oneOf.0.status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"error.oneOf.0.detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"error.oneOf.0.instance","typeLabel":"string\u003curi-reference>"}},"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"},"results_url":{"oneOf":[{"type":"string","format":"uri-reference","description":"Relative URL for the NDJSON results stream once the batch is terminal. This becomes `null` after retained result lines are cleaned up.","isRequired":true,"uniqueKey":"results_url.oneOf.0","typeLabel":"string\u003curi-reference>"},{"type":"null","format":"uri-reference","description":"Relative URL for the NDJSON results stream once the batch is terminal. This becomes `null` after retained result lines are cleaned up.","isRequired":true,"uniqueKey":"results_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results_url","typeLabel":"string\u003curi-reference> | null"}},"example":{"object":"batch_prediction","id":"bpred_abc123","status":"completed","model":"gemini-3.1-flash-lite","completion_window":"24h","created_at":"2026-04-10T12:00:00.000Z","expires_at":"2026-04-11T12:00:00.000Z","in_progress_at":"2026-04-10T12:01:00.000Z","finalizing_at":"2026-04-10T12:05:00.000Z","completed_at":"2026-04-10T12:06:00.000Z","failed_at":null,"cancelling_at":null,"cancelled_at":null,"expired_at":null,"request_counts":{"total":2,"processing":0,"succeeded":2,"errored":0,"canceled":0,"expired":0},"metadata":{"project":"alpha"},"error":null,"results_url":"/v1/batch-predictions/bpred_abc123/results"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"batch_prediction","id":"bpred_abc123","status":"completed","model":"gemini-3.1-flash-lite","completion_window":"24h","created_at":"2026-04-10T12:00:00.000Z","expires_at":"2026-04-11T12:00:00.000Z","in_progress_at":"2026-04-10T12:01:00.000Z","finalizing_at":"2026-04-10T12:05:00.000Z","completed_at":"2026-04-10T12:06:00.000Z","failed_at":null,"cancelling_at":null,"cancelled_at":null,"expired_at":null,"request_counts":{"total":2,"processing":0,"succeeded":2,"errored":0,"canceled":0,"expired":0},"metadata":{"project":"alpha"},"error":null,"results_url":"/v1/batch-predictions/bpred_abc123/results"}}},"exampleType":"generated"}},"exampleType":"generated"},"c0d4500a-0a05-43f4-acfe-eadee2bed1e7":{"description":"Unauthorized. Authentication is required to cancel a batch prediction.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"93668ada-a2de-469b-b1fd-af1bb278ed29":{"description":"Not found. The requested batch prediction does not exist.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7e17831d-ec30-433f-b070-61da79373abe":{"description":"Conflict. The batch prediction is already `completed`, `failed`, or `expired` and cannot be cancelled.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"630a1eee-0912-468d-b26c-a96fb441f00e":{"description":"Rate limit exceeded. The request has been throttled.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d9502149-5635-4363-bc2e-7245d0c5f680":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"76432f4e-9b5f-489c-85af-ee9c79f08c03":{"url":"https://api.datagrid.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"datagrid-ai-open-api.yaml"},"subdomain":"datagrid","siteName":"Datagrid AI","title":"Cancel batch prediction - Datagrid AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-06T15:01:11.208Z","originalFileLocation":"api-reference/batch-predictions/cancel-batch-prediction.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=\"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already cancelling or cancelled is returned unchanged.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Datagrid AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_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/datagrid/rhNSAymIRcJFenDe/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel batch prediction - Datagrid AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already cancelling or cancelled is returned unchanged.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Datagrid AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://datagrid.mintlify.app/_mintlify/api/og/v2?division=Batch+Predictions\u0026amp;title=Cancel+batch+prediction\u0026amp;description=Requests+cancellation+for+a+batch+prediction+that+is+still+validating+or+in+progress.+A+batch+that+is+already+%60cancelling%60+or+%60cancelled%60+is+returned+unchanged.\u0026amp;theme=93e855688d813180906429a5\u0026amp;signature=6355c5599b0637c73bbec671d594af162a87e15338dcb55d2b1dc4d8f87a265f\">\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=\"Cancel batch prediction - Datagrid AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already cancelling or cancelled is returned unchanged.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://datagrid.mintlify.app/_mintlify/api/og/v2?division=Batch+Predictions\u0026amp;title=Cancel+batch+prediction\u0026amp;description=Requests+cancellation+for+a+batch+prediction+that+is+still+validating+or+in+progress.+A+batch+that+is+already+%60cancelling%60+or+%60cancelled%60+is+returned+unchanged.\u0026amp;theme=93e855688d813180906429a5\u0026amp;signature=6355c5599b0637c73bbec671d594af162a87e15338dcb55d2b1dc4d8f87a265f\">\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/datagrid/rhNSAymIRcJFenDe/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Datagrid AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/batch-predictions/cancel-batch-prediction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.datagrid.com/#organization\",\"name\":\"Datagrid AI\",\"url\":\"https://developers.datagrid.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/datagrid/3IQk8fJ69KvSFDfU/images/datagrid-logo-light.svg?fit=max\u0026auto=format\u0026n=3IQk8fJ69KvSFDfU\u0026q=85\u0026s=c4274428e9b371bf09005fa9db0ed804\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.datagrid.com#website\",\"name\":\"Datagrid AI\",\"url\":\"https://developers.datagrid.com\",\"publisher\":{\"@id\":\"https://developers.datagrid.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction#webpage\",\"url\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction\",\"name\":\"Cancel batch prediction\",\"description\":\"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already cancelling or cancelled is returned unchanged.\",\"dateModified\":\"2026-05-06T15:01:11.208Z\",\"isPartOf\":{\"@id\":\"https://developers.datagrid.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Batch Predictions\",\"item\":\"https://developers.datagrid.com/api-reference/batch-predictions/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel batch prediction\",\"item\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction#apireference\",\"headline\":\"Cancel batch prediction\",\"name\":\"Cancel batch prediction\",\"description\":\"Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already cancelling or cancelled is returned unchanged.\",\"url\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction\",\"mainEntityOfPage\":{\"@id\":\"https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction#webpage\"},\"dateModified\":\"2026-05-06T15:01:11.208Z\",\"publisher\":{\"@id\":\"https://developers.datagrid.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.datagrid.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Datagrid AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Datagrid AI","nav":{"global":{"anchors":[{"anchor":"Get your API Key","icon":"code","href":"https://app.datagrid.com/chats?at=chats\u0026st=api_keys\u0026redirect_url=chats?at=chats%26st=api_keys"},{"anchor":"Join us on Slack","icon":"slack","href":"https://join.slack.com/t/datagrid-users/shared_invite/zt-2tl2omd78-qO8zHN5_sK39_lRsyZA4Dg"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Quickstart","href":"/introduction/quickstart"},{"title":"Connecting Agents to Apps","href":"/introduction/connections"},{"title":"Creating Data Views","href":"/introduction/data-views"},{"title":"Rate Limits","href":"/api-reference/rate-limits"},{"title":"Agent Server egress IPs","href":"/introduction/agent-server-egress-ips"}]},{"group":"Converse","pages":[{"title":"Getting started with Converse","href":"/api-reference/converse/converse-getting-started"},{"openapi":"post /converse","title":"Converse","href":"/api-reference/converse/converse"},{"title":"Converse Modes","href":"/api-reference/converse/modes"},{"title":"Knowledge and corpus","href":"/api-reference/converse/knowledge-and-corpus"},{"title":"Streaming","href":"/api-reference/converse/streaming"},{"title":"Structured Outputs","href":"/api-reference/converse/structured-outputs"},{"title":"File Inputs","href":"/api-reference/converse/file-inputs"},{"title":"MCP Servers (Beta)","href":"/api-reference/converse/mcp-servers"}]},{"group":"Voice","pages":[{"title":"Voice Conversations","href":"/api-reference/voice/voice"},{"title":"iOS / Swift Integration","href":"/api-reference/voice/ios-integration"},{"openapi":"post /voice","title":"Start voice session","href":"/api-reference/voice/start-voice-session"},{"openapi":"get /voice-orchestrator/tasks/{task_id}","title":"Retrieve voice orchestrator task","href":"/api-reference/voice/retrieve-voice-orchestrator-task"},{"openapi":"get /voice-orchestrator/tasks","title":"List voice orchestrator tasks","href":"/api-reference/voice/list-voice-orchestrator-tasks"},{"openapi":"patch /voice-orchestrator/tasks/{task_id}/acknowledge","title":"Acknowledge voice orchestrator task","href":"/api-reference/voice/acknowledge-voice-orchestrator-task"},{"openapi":"patch /voice-orchestrator/tasks/{task_id}/cancel","title":"Cancel voice orchestrator task","href":"/api-reference/voice/cancel-voice-orchestrator-task"}]},{"group":"Identity","pages":[{"openapi":"get /identity","title":"Retrieve current identity","href":"/api-reference/identity/retrieve-current-identity"}]},{"group":"Agents","pages":[{"title":"Getting started with Agents","href":"/api-reference/agents/agents"},{"title":"Getting the most out of agents","href":"/api-reference/agents/agent-best-practices"},{"openapi":"post /agents","title":"Create agent","href":"/api-reference/agents/create-agent"},{"openapi":"get /agents/{agent_id}","title":"Retrieve agent","href":"/api-reference/agents/retrieve-agent"},{"openapi":"get /agents","title":"List agents","href":"/api-reference/agents/list-agents"},{"openapi":"patch /agents/{agent_id}","title":"Update agent","href":"/api-reference/agents/update-agent"},{"openapi":"delete /agents/{agent_id}","title":"Delete agent","href":"/api-reference/agents/delete-agent"},{"openapi":"post /agents/generate","title":"Generate agent from natural language","href":"/api-reference/agents/generate-agent-from-natural-language"},{"openapi":"post /agents/claim","title":"Claim a generated agent template","href":"/api-reference/agents/claim-a-generated-agent-template"}]},{"group":"Skills","pages":[{"openapi":"post /skills","title":"Create skill","href":"/api-reference/skills/create-skill"},{"openapi":"get /skills/{skill_id}","title":"Retrieve skill","href":"/api-reference/skills/retrieve-skill"},{"openapi":"get /skills","title":"List skills","href":"/api-reference/skills/list-skills"},{"openapi":"patch /skills/{skill_id}","title":"Update skill","href":"/api-reference/skills/update-skill"},{"openapi":"delete /skills/{skill_id}","title":"Delete skill","href":"/api-reference/skills/delete-skill"},{"openapi":"post /skills/{skill_id}/clone","title":"Clone skill","href":"/api-reference/skills/clone-skill"},{"openapi":"get /skills/builtin","title":"List built-in skill catalog","href":"/api-reference/skills/list-built-in-skill-catalog"},{"openapi":"post /skills/builtin/{builtin_key}/override","title":"Override built-in skill","href":"/api-reference/skills/override-built-in-skill"},{"openapi":"post /skills/builtin/{builtin_key}/reset","title":"Reset built-in skill override","href":"/api-reference/skills/reset-built-in-skill-override"},{"openapi":"post /skills/{skill_id}/promote","title":"Promote skill to company","href":"/api-reference/skills/promote-skill-to-company"},{"openapi":"post /skills/{skill_id}/demote","title":"Demote skill to private","href":"/api-reference/skills/demote-skill-to-private"},{"openapi":"post /skills/generate","title":"Generate skill drafts","href":"/api-reference/skills/generate-skill-drafts"}]},{"group":"Automations","pages":[{"openapi":"post /agents/{agent_id}/automations","title":"Create automation","href":"/api-reference/automations/create-automation"},{"openapi":"get /agents/{agent_id}/automations/{automation_id}","title":"Retrieve automation","href":"/api-reference/automations/retrieve-automation"},{"openapi":"get /agents/{agent_id}/automations","title":"List automations","href":"/api-reference/automations/list-automations"},{"openapi":"patch /agents/{agent_id}/automations/{automation_id}","title":"Update automation","href":"/api-reference/automations/update-automation"},{"openapi":"delete /agents/{agent_id}/automations/{automation_id}","title":"Delete automation","href":"/api-reference/automations/delete-automation"}]},{"group":"Knowledge","pages":[{"openapi":"post /knowledge","title":"Create knowledge","href":"/api-reference/knowledge/create-knowledge"},{"openapi":"post /knowledge/connect","title":"Create knowledge from connection","href":"/api-reference/knowledge/create-knowledge-from-connection"},{"openapi":"get /knowledge/{knowledge_id}","title":"Retrieve knowledge","href":"/api-reference/knowledge/retrieve-knowledge"},{"openapi":"get /knowledge","title":"List knowledge","href":"/api-reference/knowledge/list-knowledge"},{"openapi":"patch /knowledge/{knowledge_id}","title":"Update knowledge","href":"/api-reference/knowledge/update-knowledge"},{"openapi":"delete /knowledge/{knowledge_id}","title":"Delete knowledge","href":"/api-reference/knowledge/delete-knowledge"},{"openapi":"post /knowledge/{knowledge_id}/reindex","title":"Reindex knowledge","href":"/api-reference/knowledge/reindex-knowledge"},{"title":"Knowledge upload limits","href":"/knowledge/upload-limits"},{"group":"Tables","pages":[{"openapi":"get /tables/{table_id}","title":"Retrieve table","href":"/api-reference/tables/retrieve-table"},{"openapi":"get /tables","title":"List tables","href":"/api-reference/tables/list-tables"},{"openapi":"get /tables/{table_id}/records","title":"List records","href":"/api-reference/tables/list-records"},{"openapi":"get /tables/{table_id}/summaries","title":"List summaries","href":"/api-reference/tables/list-summaries"},{"title":"Replicating Tables","href":"/api-reference/tables/replicating-tables"}]},{"group":"Data Views","pages":[{"openapi":"post /data-views","title":"Create data view","href":"/api-reference/data-views/create-data-view"},{"openapi":"get /data-views","title":"List data views","href":"/api-reference/data-views/list-data-views"},{"openapi":"delete /data-views/{data_view_id}","title":"Delete data view","href":"/api-reference/data-views/delete-data-view"},{"openapi":"post /data-views/service-accounts","title":"Create service account","href":"/api-reference/data-views/create-service-account"},{"openapi":"get /data-views/service-accounts","title":"List service accounts","href":"/api-reference/data-views/list-service-accounts"},{"openapi":"delete /data-views/service-accounts/{service_account_id}","title":"Delete service account","href":"/api-reference/data-views/delete-service-account"},{"openapi":"get /data-views/service-accounts/{service_account_id}/credentials","title":"Get service account credentials","href":"/api-reference/data-views/get-service-account-credentials"}]}]},{"group":"Search","pages":[{"openapi":"get /search","title":"Search","href":"/api-reference/search/search"},{"openapi":"get /search/tree","title":"Search Tree","href":"/api-reference/search/search-tree"},{"openapi":"post /search/ai","title":"AI Search","href":"/api-reference/search/ai-search"}]},{"group":"Conversations","pages":[{"openapi":"post /conversations","title":"Create conversation","href":"/api-reference/conversations/create-conversation"},{"openapi":"get /conversations/{conversation_id}","title":"Retrieve conversation","href":"/api-reference/conversations/retrieve-conversation"},{"openapi":"get /conversations","title":"List conversations","href":"/api-reference/conversations/list-conversations"},{"openapi":"delete /conversations/{conversation_id}","title":"Delete conversation","href":"/api-reference/conversations/delete-conversation"},{"openapi":"patch /conversations/{conversation_id}","title":"Update conversation","href":"/api-reference/conversations/update-conversation"}]},{"group":"Messages","pages":[{"openapi":"get /conversations/{conversation_id}/messages/{message_id}","title":"Retrieve message","href":"/api-reference/conversations/retrieve-message"},{"openapi":"get /conversations/{conversation_id}/messages","title":"List messages","href":"/api-reference/conversations/list-messages"},{"openapi":"post /conversations/{conversation_id}/messages/{message_id}","title":"Submit message feedback","href":"/api-reference/conversations/submit-message-feedback"}]},{"group":"Connections","pages":[{"openapi":"post /connections","title":"Create connection","href":"/api-reference/connections/create-connection"},{"openapi":"get /connections/{connection_id}","title":"Retrieve connection","href":"/api-reference/connections/retrieve-connection"},{"openapi":"get /connections","title":"List connections","href":"/api-reference/connections/list-connections"},{"openapi":"patch /connections/{connection_id}","title":"Update connection","href":"/api-reference/connections/update-connection"},{"openapi":"delete /connections/{connection_id}","title":"Delete connection","href":"/api-reference/connections/delete-connection"}]},{"group":"Connection Providers","pages":[{"openapi":"post /connection-providers","title":"Create connection provider","href":"/api-reference/connection-providers/create-connection-provider"},{"openapi":"get /connection-providers/{connection_provider_id}","title":"Retrieve connection provider","href":"/api-reference/connection-providers/retrieve-connection-provider"},{"openapi":"get /connection-providers","title":"List connection providers","href":"/api-reference/connection-providers/list-connection-providers"},{"openapi":"patch /connection-providers/{connection_provider_id}","title":"Update connection provider","href":"/api-reference/connection-providers/update-connection-provider"},{"openapi":"delete /connection-providers/{connection_provider_id}","title":"Delete connection provider","href":"/api-reference/connection-providers/delete-connection-provider"}]},{"group":"Connectors","pages":[{"openapi":"get /connectors","title":"List connectors","href":"/api-reference/connectors/list-connectors"},{"openapi":"get /connectors/health","title":"Get connector health","href":"/api-reference/connectors/get-connector-health"}]},{"group":"Files","pages":[{"openapi":"post /files","title":"Create files","href":"/api-reference/files/create-files"},{"openapi":"get /files/{file_id}","title":"Retrieve file","href":"/api-reference/files/retrieve-file"},{"openapi":"get /files","title":"List files","href":"/api-reference/files/list-files"},{"openapi":"delete /files/{file_id}","title":"Delete file","href":"/api-reference/files/delete-file"},{"openapi":"get /files/{file_id}/content","title":"Retrieve file content","href":"/api-reference/files/retrieve-file-content"},{"openapi":"patch /files/{file_id}","title":"Update file","href":"/api-reference/files/update-file"}]},{"group":"Tools","pages":[{"openapi":"get /tools/{tool_name}","title":"Retrieve tool","href":"/api-reference/tools/retrieve-tool"},{"openapi":"get /tools","title":"List tools","href":"/api-reference/tools/list-tools"}]},{"group":"Models","pages":[{"openapi":"get /models","title":"List models","href":"/api-reference/models/list-models"}]},{"group":"Secrets","pages":[{"openapi":"post /secrets","title":"Create secret","href":"/api-reference/secrets/create-secret"},{"openapi":"get /secrets/{secret_id}","title":"Retrieve secret","href":"/api-reference/secrets/retrieve-secret"},{"openapi":"get /secrets","title":"List secrets","href":"/api-reference/secrets/list-secrets"},{"openapi":"delete /secrets/{secret_id}","title":"Delete secret","href":"/api-reference/secrets/delete-secret"}]},{"group":"Webhooks","pages":[{"title":"Webhooks overview","href":"/api-reference/webhooks/overview"},{"openapi":"post /webhooks","title":"Create webhook","href":"/api-reference/webhooks/create-webhook"},{"openapi":"get /webhooks/{webhook_id}","title":"Retrieve webhook","href":"/api-reference/webhooks/retrieve-webhook"},{"openapi":"get /webhooks","title":"List webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"patch /webhooks/{webhook_id}","title":"Update webhook","href":"/api-reference/webhooks/update-webhook"},{"openapi":"delete /webhooks/{webhook_id}","title":"Delete webhook","href":"/api-reference/webhooks/delete-webhook"},{"openapi":"get /webhooks/active","title":"List active webhooks for event","href":"/api-reference/webhooks/list-active-webhooks-for-event"}]},{"group":"Memory","pages":[{"openapi":"post /user-memories","title":"Create User Memory","href":"/api-reference/memory/create-user-memory"},{"openapi":"get /user-memories","title":"List User Memory","href":"/api-reference/memory/list-user-memory"},{"openapi":"delete /user-memories/{user_memory_id}","title":"Delete User Memory","href":"/api-reference/memory/delete-user-memory"}]},{"group":"Pages","pages":[{"openapi":"post /pages","title":"Create page","href":"/api-reference/pages/create-page"},{"openapi":"get /pages/{page_id}","title":"Retrieve page","href":"/api-reference/pages/retrieve-page"},{"openapi":"get /pages","title":"List pages","href":"/api-reference/pages/list-pages"},{"openapi":"patch /pages/{page_id}","title":"Update page","href":"/api-reference/pages/update-page"},{"openapi":"delete /pages/{page_id}","title":"Delete page","href":"/api-reference/pages/delete-page"}]},{"group":"MCP Servers - Beta","pages":[{"title":"Overview","href":"/api-reference/mcp-servers/overview"},{"openapi":"post /organization/mcp-servers","title":"Create MCP server","href":"/api-reference/mcp-servers/create-mcp-server"},{"openapi":"get /organization/mcp-servers/{server_id}","title":"Retrieve MCP server","href":"/api-reference/mcp-servers/retrieve-mcp-server"},{"openapi":"get /organization/mcp-servers","title":"List MCP servers","href":"/api-reference/mcp-servers/list-mcp-servers"},{"openapi":"patch /organization/mcp-servers/{server_id}","title":"Update MCP server","href":"/api-reference/mcp-servers/update-mcp-server"},{"openapi":"delete /organization/mcp-servers/{server_id}","title":"Delete MCP server","href":"/api-reference/mcp-servers/delete-mcp-server"},{"openapi":"post /organization/mcp-servers/{server_id}/start-oauth","title":"Start MCP OAuth flow","href":"/api-reference/mcp-servers/start-mcp-oauth-flow"},{"openapi":"post /organization/mcp-servers/{server_id}/oauth-callback","title":"Complete MCP OAuth flow","href":"/api-reference/mcp-servers/complete-mcp-oauth-flow"}]},{"group":"Batch Predictions","pages":[{"title":"Batch Predictions overview","href":"/api-reference/batch-predictions/overview"},{"openapi":"post /batch-predictions","title":"Create batch prediction","href":"/api-reference/batch-predictions/create-batch-prediction"},{"openapi":"get /batch-predictions/{batch_prediction_id}","title":"Retrieve batch prediction","href":"/api-reference/batch-predictions/retrieve-batch-prediction"},{"openapi":"get /batch-predictions","title":"List batch predictions","description":"Returns batch predictions for the authenticated teamspace in reverse chronological order. Use `after` with `next_cursor` from the previous response to paginate.","href":"/api-reference/batch-predictions/list-batch-predictions"},{"openapi":"post /batch-predictions/{batch_prediction_id}/cancel","title":"Cancel batch prediction","href":"/api-reference/batch-predictions/cancel-batch-prediction"},{"openapi":"get /batch-predictions/{batch_prediction_id}/results","title":"Retrieve batch prediction results","description":"Streams newline-delimited JSON (NDJSON) result lines for a terminal batch prediction. Read the response body line-by-line and JSON parse each non-empty line. Results are retained for a limited window after batch creation; after cleanup, this endpoint returns `410 Gone`.","href":"/api-reference/batch-predictions/retrieve-batch-prediction-results"},{"title":"Batch prediction errors","href":"/api-reference/batch-predictions/errors"}]},{"group":"Event Triggers","pages":[{"title":"Event Triggers overview","href":"/api-reference/event-triggers/overview"},{"openapi":"post /agents/{agent_id}/event-triggers","title":"Create event trigger","href":"/api-reference/event-triggers/create-event-trigger"},{"openapi":"get /agents/{agent_id}/event-triggers","title":"List event triggers","href":"/api-reference/event-triggers/list-event-triggers"},{"openapi":"patch /agents/{agent_id}/event-triggers/{trigger_id}","title":"Update event trigger","href":"/api-reference/event-triggers/update-event-trigger"},{"openapi":"delete /agents/{agent_id}/event-triggers/{trigger_id}","title":"Delete event trigger","href":"/api-reference/event-triggers/delete-event-trigger"}]},{"group":"Channels","pages":[{"openapi":"post /channels","title":"Create channel","href":"/api-reference/channels/create-channel"},{"openapi":"post /channels/{channel_id}/messages","title":"Create channel message","href":"/api-reference/channels/create-channel-message"},{"openapi":"post /channels/{channel_id}/threads/{thread_id}/messages","title":"Create thread message","href":"/api-reference/channels/create-thread-message"},{"openapi":"get /channels/{channel_id}","title":"Retrieve channel","href":"/api-reference/channels/retrieve-channel"},{"openapi":"get /channels/{channel_id}/threads/{thread_id}","title":"Retrieve channel thread","href":"/api-reference/channels/retrieve-channel-thread"},{"openapi":"get /channels","title":"List channels","href":"/api-reference/channels/list-channels"},{"openapi":"get /channels/{channel_id}/members","title":"List channel members","href":"/api-reference/channels/list-channel-members"},{"openapi":"get /channels/{channel_id}/messages","title":"List channel messages","href":"/api-reference/channels/list-channel-messages"},{"openapi":"get /channels/{channel_id}/threads","title":"List channel threads","href":"/api-reference/channels/list-channel-threads"},{"openapi":"get /channels/{channel_id}/threads/{thread_id}/messages","title":"List thread messages","href":"/api-reference/channels/list-thread-messages"},{"openapi":"patch /channels/{channel_id}","title":"Update channel","href":"/api-reference/channels/update-channel"},{"openapi":"post /channels/{channel_id}/members","title":"Add channel members","href":"/api-reference/channels/add-channel-members"},{"openapi":"delete /channels/{channel_id}/members/{member_id}","title":"Remove channel member","href":"/api-reference/channels/remove-channel-member"},{"openapi":"post /channels/{channel_id}/messages/{message_id}/threads","title":"Start a thread","href":"/api-reference/channels/start-a-thread"},{"openapi":"post /channels/{channel_id}/messages/{message_id}/reactions","title":"Add a message reaction","href":"/api-reference/channels/add-a-message-reaction"},{"openapi":"delete /channels/{channel_id}/messages/{message_id}/reactions/{reaction}","title":"Remove a message reaction","href":"/api-reference/channels/remove-a-message-reaction"}]},{"group":"Procore","pages":[{"openapi":"get /procore/companies","title":"List Procore companies","href":"/api-reference/procore/list-procore-companies"},{"openapi":"get /procore/companies/{company_id}/projects","title":"List Procore projects in a company","href":"/api-reference/procore/list-procore-projects-in-a-company"}]},{"group":"Organization","pages":[{"group":"Credits","pages":[{"openapi":"get /organization/credits","title":"Get credits","href":"/api-reference/credits/get-credits"},{"openapi":"get /organization/reports/user-credits-consumption","title":"List user credit consumption","href":"/api-reference/credits/list-user-credit-consumption"},{"openapi":"get /organization/reports/consumption-breakdown","title":"List consumption breakdown","href":"/api-reference/credits/list-consumption-breakdown"}]},{"group":"Users","pages":[{"openapi":"get /organization/users/{user_id}","title":"Retrieve user","href":"/api-reference/users/retrieve-user"},{"openapi":"get /organization/users","title":"List users","href":"/api-reference/users/list-users"},{"openapi":"patch /organization/users/{user_id}","title":"Update user","href":"/api-reference/users/update-user"}]},{"group":"Teamspaces","pages":[{"openapi":"post /organization/teamspaces","title":"Create teamspace","href":"/api-reference/teamspaces/create-teamspace"},{"openapi":"get /organization/teamspaces/{teamspace_id}","title":"Retrieve teamspace","href":"/api-reference/teamspaces/retrieve-teamspace"},{"openapi":"get /organization/teamspaces","title":"List teamspaces","href":"/api-reference/teamspaces/list-teamspaces"},{"openapi":"patch /organization/teamspaces/{teamspace_id}","title":"Update teamspace","href":"/api-reference/teamspaces/update-teamspace"},{"title":"Scope Requests to a Teamspace","href":"/api-reference/teamspaces/scope-to-teamspace"}]},{"group":"Teamspace Invites","pages":[{"openapi":"post /organization/teamspaces/{teamspace_id}/invites","title":"Invite user to a teamspace","href":"/api-reference/teamspace-invites/invite-user-to-a-teamspace"},{"openapi":"get /organization/teamspaces/{teamspace_id}/invites/{invite_id}","title":"Retrieve teamspace invite","href":"/api-reference/teamspace-invites/retrieve-teamspace-invite"},{"openapi":"get /organization/teamspaces/{teamspace_id}/invites","title":"List teamspace invites","href":"/api-reference/teamspace-invites/list-teamspace-invites"},{"openapi":"delete /organization/teamspaces/{teamspace_id}/invites/{invite_id}","title":"Delete teamspace invite","href":"/api-reference/teamspace-invites/delete-teamspace-invite"}]},{"group":"Teamspace Users","pages":[{"openapi":"get /organization/teamspaces/{teamspace_id}/users/{user_id}","title":"Retrieve teamspace user","href":"/api-reference/teamspace-users/retrieve-teamspace-user"},{"openapi":"get /organization/teamspaces/{teamspace_id}/users","title":"List teamspace users","href":"/api-reference/teamspace-users/list-teamspace-users"},{"openapi":"patch /organization/teamspaces/{teamspace_id}/users/{user_id}","title":"Update teamspace user","href":"/api-reference/teamspace-users/update-teamspace-user"},{"openapi":"delete /organization/teamspaces/{teamspace_id}/users/{user_id}","title":"Delete teamspace user","href":"/api-reference/teamspace-users/delete-teamspace-user"}]}]}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/connectors/all-connectors"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026-08"}]}]},"basePath":"","title":"Cancel batch prediction - Datagrid AI","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}