Credit consumption for this search. When present, consumed reflects the actual variable cost of the retrieval work performed for this request. null when the billing write fails or the request is aborted before billing completes.
Show child attributes
{"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/search/search","slug":"/api-reference/search/search","pageMetadata":{"openapi":"get /search","title":"Search","description":"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.","href":"/api-reference/search/search"},"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: \"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.\"\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":"get /search","title":"Search","description":"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.","href":"/api-reference/search/search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/datagrid/63000a1b04510866/tools/jest.config.js"],"openApiReferenceData":{"operation":{"summary":"Search","deprecated":true,"description":"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.","operationId":"search","tags":["Search"],"parameters":["689d7326-6039-4a31-a254-bf899b168519","22828bdd-4925-4bfb-bf7b-380426ce1a9d","c051e0c4-51df-4291-ad3e-5f3572637399","85bb857c-d7b7-4ed6-95a9-37b1b9571fc3","f9f88277-9b72-44ea-aa90-5a7ba0ccb5bf"],"responses":{"200":"203659ae-aac9-47cd-b093-9dfd62feff09","400":"3984e3da-4921-484f-999e-2b8826cedec5","402":"29a5c050-b6eb-4cd2-af0a-ed0dcfefb20f","429":"32d711f0-c54f-4371-bdc7-682d27a5ad10"},"method":"get","type":"path","servers":["76432f4e-9b5f-489c-85af-ee9c79f08c03"],"security":["d9502149-5635-4363-bc2e-7245d0c5f680"],"path":"/search","baseUrlOptions":["https://api.datagrid.com/v1"],"title":"Search","codeSamples":[],"requestExampleLanguages":["python","javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"689d7326-6039-4a31-a254-bf899b168519":{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"isRequired":true,"description":"The search query to run against knowledge. Must contain at least one non-whitespace character after trimming.","uniqueKey":"","typeLabel":"string"},"description":"The search query to run against knowledge. Must contain at least one non-whitespace character after trimming."},"22828bdd-4925-4bfb-bf7b-380426ce1a9d":{"name":"knowledge_ids","description":"Optional list of knowledge IDs to scope the search to.","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"Optional list of knowledge IDs to scope the search to.","uniqueKey":"","typeLabel":"string[]"}},"c051e0c4-51df-4291-ad3e-5f3572637399":{"name":"record_types","description":"Filter results by record type in the vector database.","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","description":"The record type in the vector database.","enum":["rows","tables","files","pages","cells"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Filter results by record type in the vector database.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"85bb857c-d7b7-4ed6-95a9-37b1b9571fc3":{"name":"next","in":"query","schema":{"type":"string","isRequired":false,"description":"A cursor to use in pagination to continue a query from the previous request. This is automatically added when the request has more results to fetch.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"A cursor to use in pagination to continue a query from the previous request. This is automatically added when the request has more results to fetch."},"f9f88277-9b72-44ea-aa90-5a7ba0ccb5bf":{"name":"limit","in":"query","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"isRequired":false,"description":"The limit on the number of objects to return, ranging between 1 and 100.","uniqueKey":"","typeLabel":"integer"},"required":false,"description":"The limit on the number of objects to return, ranging between 1 and 100."}},"responses":{"203659ae-aac9-47cd-b093-9dfd62feff09":{"description":"Search results","content":{"application/json":{"schema":{"type":"object","required":["object","data","credits"],"properties":{"object":{"type":"string","enum":["list"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"data":{"type":"array","items":{"type":"object","required":["object","score","updated_at","content","resource"],"properties":{"object":{"type":"string","enum":["search_result_item"],"description":"The object type, which is always `search_result_item`.","isRequired":true,"uniqueKey":"data.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"score":{"type":"number","description":"The score of the item, between 0 and 1.","isRequired":true,"uniqueKey":"data.items.[INDEX].score","typeLabel":"number"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the item was last updated.","isRequired":true,"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"content":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].content.items.[INDEX]","typeLabel":"string"},"description":"Text snippets relevant to the search query.","isRequired":true,"uniqueKey":"data.items.[INDEX].content","typeLabel":"string[]"},"resource":{"oneOf":[{"type":"object","description":"The resource that matched the search query.","required":["object","id","name","navigation_item","url"],"properties":{"object":{"type":"string","enum":["knowledge_metadata"],"description":"The object type, which is always `knowledge_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.name","typeLabel":"string"},"navigation_item":{"type":"object","description":"The navigation item of the knowledge.","required":["object","id","name","url","item_type"],"properties":{"object":{"type":"string","enum":["navigation_item_metadata"],"description":"The object type, which is always `navigation_item_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.name","typeLabel":"string"},"item_type":{"type":"string","description":"The type of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.item_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.url","typeLabel":"string"},"emoticon":{"type":"string","description":"The emoticon of the navigation item.","uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.emoticon","typeLabel":"string"},"source_media_type":{"type":"string","description":"The media type of the navigation item if known.","uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item.source_media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.navigation_item","typeLabel":"object"},"url":{"type":"string","description":"The url of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.0","typeLabel":"object"},{"type":"object","description":"The resource that matched the search query.","required":["object","id","name","knowledge","url"],"properties":{"object":{"type":"string","enum":["table_metadata"],"description":"The object type, which is always `table_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier for the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.name","typeLabel":"string"},"knowledge":{"type":"object","description":"The knowledge object that the table belongs to.","required":["object","id","name","navigation_item","url"],"properties":{"object":{"type":"string","enum":["knowledge_metadata"],"description":"The object type, which is always `knowledge_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.name","typeLabel":"string"},"navigation_item":{"type":"object","description":"The navigation item of the knowledge.","required":["object","id","name","url","item_type"],"properties":{"object":{"type":"string","enum":["navigation_item_metadata"],"description":"The object type, which is always `navigation_item_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.name","typeLabel":"string"},"item_type":{"type":"string","description":"The type of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.item_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.url","typeLabel":"string"},"emoticon":{"type":"string","description":"The emoticon of the navigation item.","uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.emoticon","typeLabel":"string"},"source_media_type":{"type":"string","description":"The media type of the navigation item if known.","uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item.source_media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.navigation_item","typeLabel":"object"},"url":{"type":"string","description":"The url of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.knowledge","typeLabel":"object"},"url":{"type":"string","description":"The url of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.1","typeLabel":"object"},{"type":"object","description":"The resource that matched the search query.","required":["object","id","table","url"],"properties":{"object":{"type":"string","enum":["row_metadata"],"description":"The object type, which is always `row_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the row (__datagrid__uuid), unique within the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.id","typeLabel":"string"},"table":{"type":"object","description":"The table that the row belongs to.","required":["object","id","name","knowledge","url"],"properties":{"object":{"type":"string","enum":["table_metadata"],"description":"The object type, which is always `table_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier for the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.name","typeLabel":"string"},"knowledge":{"type":"object","description":"The knowledge object that the table belongs to.","required":["object","id","name","navigation_item","url"],"properties":{"object":{"type":"string","enum":["knowledge_metadata"],"description":"The object type, which is always `knowledge_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.name","typeLabel":"string"},"navigation_item":{"type":"object","description":"The navigation item of the knowledge.","required":["object","id","name","url","item_type"],"properties":{"object":{"type":"string","enum":["navigation_item_metadata"],"description":"The object type, which is always `navigation_item_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.name","typeLabel":"string"},"item_type":{"type":"string","description":"The type of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.item_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.url","typeLabel":"string"},"emoticon":{"type":"string","description":"The emoticon of the navigation item.","uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.emoticon","typeLabel":"string"},"source_media_type":{"type":"string","description":"The media type of the navigation item if known.","uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item.source_media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.navigation_item","typeLabel":"object"},"url":{"type":"string","description":"The url of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.knowledge","typeLabel":"object"},"url":{"type":"string","description":"The url of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.table","typeLabel":"object"},"url":{"type":"string","description":"The url of the row of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.2","typeLabel":"object"},{"type":"object","description":"The resource that matched the search query.","required":["object","media_type","name","source","url"],"properties":{"object":{"type":"string","enum":["attachment_metadata"],"description":"The object type, which is always `attachment_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.object","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the attachment.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.name","typeLabel":"string"},"media_type":{"type":"string","description":"The media type of the attachment.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.media_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the blob of the attachment.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.url","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"The source of the attachment.","required":["object","conversation","id","author_id","author_type","url"],"properties":{"object":{"type":"string","enum":["message_metadata"],"description":"The object type, which is always `message_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.object","typeLabel":"enum\u003cstring>"},"conversation":{"type":"object","description":"The conversation that the message belongs to.","required":["object","id","url","name","navigation_item"],"properties":{"object":{"type":"string","enum":["conversation_metadata"],"description":"The object type, which is always `conversation_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the conversation.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.id","typeLabel":"string"},"url":{"type":"string","description":"The url of the conversation.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.url","typeLabel":"string"},"navigation_item":{"type":"object","description":"The navigation item of the conversation.","required":["object","id","name","url","item_type"],"properties":{"object":{"type":"string","enum":["navigation_item_metadata"],"description":"The object type, which is always `navigation_item_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.name","typeLabel":"string"},"item_type":{"type":"string","description":"The type of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.item_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.url","typeLabel":"string"},"emoticon":{"type":"string","description":"The emoticon of the navigation item.","uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.emoticon","typeLabel":"string"},"source_media_type":{"type":"string","description":"The media type of the navigation item if known.","uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item.source_media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.navigation_item","typeLabel":"object"},"name":{"type":"string","description":"The name of the conversation.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.conversation","typeLabel":"object"},"id":{"type":"string","description":"The id of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.id","typeLabel":"string"},"author_id":{"type":"string","description":"The identifier of the message author (either a user ID or agent ID).","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.author_id","typeLabel":"string"},"author_type":{"type":"string","enum":["user","agent"],"description":"Indicates whether the author is a user or an agent.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.author_type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"The url of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.url","typeLabel":"string"},"author_name":{"type":"string","description":"The pretty name of the author of the message.","uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0.author_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.0","typeLabel":"object"},{"type":"object","description":"The source of the attachment.","required":["object","id","table","url"],"properties":{"object":{"type":"string","enum":["row_metadata"],"description":"The object type, which is always `row_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the row (__datagrid__uuid), unique within the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.id","typeLabel":"string"},"table":{"type":"object","description":"The table that the row belongs to.","required":["object","id","name","knowledge","url"],"properties":{"object":{"type":"string","enum":["table_metadata"],"description":"The object type, which is always `table_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier for the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.name","typeLabel":"string"},"knowledge":{"type":"object","description":"The knowledge object that the table belongs to.","required":["object","id","name","navigation_item","url"],"properties":{"object":{"type":"string","enum":["knowledge_metadata"],"description":"The object type, which is always `knowledge_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.name","typeLabel":"string"},"navigation_item":{"type":"object","description":"The navigation item of the knowledge.","required":["object","id","name","url","item_type"],"properties":{"object":{"type":"string","enum":["navigation_item_metadata"],"description":"The object type, which is always `navigation_item_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.name","typeLabel":"string"},"item_type":{"type":"string","description":"The type of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.item_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.url","typeLabel":"string"},"emoticon":{"type":"string","description":"The emoticon of the navigation item.","uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.emoticon","typeLabel":"string"},"source_media_type":{"type":"string","description":"The media type of the navigation item if known.","uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item.source_media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.navigation_item","typeLabel":"object"},"url":{"type":"string","description":"The url of the knowledge.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.knowledge","typeLabel":"object"},"url":{"type":"string","description":"The url of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.table","typeLabel":"object"},"url":{"type":"string","description":"The url of the row of the table.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.source","typeLabel":"object"},"data_lake_item_id":{"type":"string","description":"The data lake item ID of the attachment, used to generate fresh signed URLs.","uniqueKey":"data.items.[INDEX].resource.oneOf.3.data_lake_item_id","typeLabel":"string"},"page":{"type":"object","required":["page_number","url","pageNumber"],"properties":{"page_number":{"type":"number","description":"The page number of the attachment.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.page.page_number","typeLabel":"number"},"url":{"type":"string","description":"The url of the blob of the page.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.page.url","typeLabel":"string"},"pageNumber":{"type":"number","description":"DEPRECATED use page_number instead.","deprecated":true,"x-stainless-naming":{"python":{"property_name":"page_number_deprecated"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3.page.pageNumber","typeLabel":"number"}},"uniqueKey":"data.items.[INDEX].resource.oneOf.3.page","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.3","typeLabel":"object"},{"type":"object","description":"The resource that matched the search query.","required":["object","conversation","id","author_id","author_type","url"],"properties":{"object":{"type":"string","enum":["message_metadata"],"description":"The object type, which is always `message_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.object","typeLabel":"enum\u003cstring>"},"conversation":{"type":"object","description":"The conversation that the message belongs to.","required":["object","id","url","name","navigation_item"],"properties":{"object":{"type":"string","enum":["conversation_metadata"],"description":"The object type, which is always `conversation_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the conversation.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.id","typeLabel":"string"},"url":{"type":"string","description":"The url of the conversation.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.url","typeLabel":"string"},"navigation_item":{"type":"object","description":"The navigation item of the conversation.","required":["object","id","name","url","item_type"],"properties":{"object":{"type":"string","enum":["navigation_item_metadata"],"description":"The object type, which is always `navigation_item_metadata`.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The id of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.name","typeLabel":"string"},"item_type":{"type":"string","description":"The type of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.item_type","typeLabel":"string"},"url":{"type":"string","description":"The url of the navigation item.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.url","typeLabel":"string"},"emoticon":{"type":"string","description":"The emoticon of the navigation item.","uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.emoticon","typeLabel":"string"},"source_media_type":{"type":"string","description":"The media type of the navigation item if known.","uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item.source_media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.navigation_item","typeLabel":"object"},"name":{"type":"string","description":"The name of the conversation.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.conversation","typeLabel":"object"},"id":{"type":"string","description":"The id of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.id","typeLabel":"string"},"author_id":{"type":"string","description":"The identifier of the message author (either a user ID or agent ID).","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.author_id","typeLabel":"string"},"author_type":{"type":"string","enum":["user","agent"],"description":"Indicates whether the author is a user or an agent.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.author_type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"The url of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4.url","typeLabel":"string"},"author_name":{"type":"string","description":"The pretty name of the author of the message.","uniqueKey":"data.items.[INDEX].resource.oneOf.4.author_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].resource.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].resource","typeLabel":"object"},"title":{"type":"string","description":"The title of the item.","uniqueKey":"data.items.[INDEX].title","typeLabel":"string"},"summary":{"type":"string","description":"The summary of the item.","uniqueKey":"data.items.[INDEX].summary","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"An array containing the found search items.","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"credits":{"oneOf":[{"type":"object","description":"Credit consumption for this search. When present, `consumed` reflects the actual variable cost of the retrieval work performed for this request. `null` when the billing write fails or the request is aborted before billing completes.","required":["consumed"],"properties":{"consumed":{"type":"number","description":"The number of credits consumed by the operation.","isRequired":true,"uniqueKey":"credits.oneOf.0.consumed","typeLabel":"number"}},"isRequired":true,"uniqueKey":"credits.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"credits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credits","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"list","data":[{"object":"search_result_item","score":123,"updated_at":"2023-11-07T05:31:56Z","content":["\u003cstring>"],"resource":{"object":"knowledge_metadata","id":"\u003cstring>","name":"\u003cstring>","navigation_item":{"object":"navigation_item_metadata","id":"\u003cstring>","name":"\u003cstring>","item_type":"\u003cstring>","url":"\u003cstring>","emoticon":"\u003cstring>","source_media_type":"\u003cstring>"},"url":"\u003cstring>"},"title":"\u003cstring>","summary":"\u003cstring>"}],"credits":{"consumed":123}}}},"exampleType":"generated"}},"headers":{"X-Daily-Credit-Cap-Remaining":{"description":"Credits left before the account's daily credit cap (set in Control Tower) is reached, rounded up. `0` means the cap has been reached; the daily cap does not block requests. Present only when a daily cap is configured.","schema":{"type":"integer","example":600}},"X-Monthly-Credit-Cap-Remaining":{"description":"Credits left before the account's monthly credit cap (set in Control Tower) is reached, rounded up. At `0`, credit-consuming requests return `402` until the next calendar month. Present only when a monthly cap is configured.","schema":{"type":"integer","example":15000}}},"exampleType":"generated"},"3984e3da-4921-484f-999e-2b8826cedec5":{"description":"Bad request. The search query must contain at least one non-whitespace character.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"29a5c050-b6eb-4cd2-af0a-ed0dcfefb20f":{"description":"Credit limit exceeded. Either the organization does not have enough credits to perform this search, or it has reached the monthly credit cap set in Control Tower. Check your billing status, or wait for the cap to reset.","headers":{"X-Daily-Credit-Cap-Remaining":{"description":"Credits left before the account's daily credit cap (set in Control Tower) is reached, rounded up. `0` means the cap has been reached; the daily cap does not block requests. Present only when a daily cap is configured.","schema":{"type":"integer","example":600}},"X-Monthly-Credit-Cap-Remaining":{"description":"Credits left before the account's monthly credit cap (set in Control Tower) is reached, rounded up. At `0`, credit-consuming requests return `402` until the next calendar month. Present only when a monthly cap is configured.","schema":{"type":"integer","example":15000}}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"32d711f0-c54f-4371-bdc7-682d27a5ad10":{"description":"Rate limit exceeded. The request has been throttled because the rate limit for this endpoint has been reached. Check the `Retry-After` response header and retry after the specified number of seconds.","content":{"application/json":{"schema":{"type":"object","description":"Returned when the rate limit is exceeded. Rate limits are enforced per teamspace, endpoint path, and HTTP method over a 60-second sliding window. Each endpoint may have its own limit — check the X-RateLimit-Limit response header for the effective value.","required":["error","message","retryable","status_code"],"properties":{"status_code":{"type":"integer","description":"The HTTP status code (429).","isRequired":true,"uniqueKey":"status_code","typeLabel":"integer"},"error":{"type":"string","enum":["rate_limit_exceeded"],"description":"The error code identifying this as a rate limit error.","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether the request can be retried after a delay.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"statusCode":{"type":"integer","deprecated":true,"description":"Deprecated. Use status_code instead.","uniqueKey":"statusCode","typeLabel":"integer"},"mitigation":{"type":"string","description":"Suggested action to resolve the error.","uniqueKey":"mitigation","typeLabel":"string"},"details":{"type":"object","properties":{"reason":{"type":"string","description":"A detailed explanation of why the rate limit was exceeded.","uniqueKey":"details.reason","typeLabel":"string"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status_code":123,"error":"rate_limit_exceeded","message":"\u003cstring>","retryable":true,"statusCode":123,"mitigation":"\u003cstring>","details":{"reason":"\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":"Search - Datagrid AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-01T12:28:34.539Z","originalFileLocation":"api-reference/search/search.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=\"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.\">\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=\"Search - Datagrid AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.\">\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/search/search\">\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=Search\u0026amp;title=Search\u0026amp;description=%5BDEPRECATED%5D+Search+across+knowledge.+Use+%2Fsearch%2Fai+for+AI-powered+generative+search+or+%2Fsearch%2Ftree+for+merged+context+tree+results.\u0026amp;theme=93e855688d813180906429a5\u0026amp;signature=0a03ed024ad7796ac3ce7aa83d058d118f137b1fb2a8d6dd9ec415428413deae\">\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=\"Search - Datagrid AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://datagrid.mintlify.app/_mintlify/api/og/v2?division=Search\u0026amp;title=Search\u0026amp;description=%5BDEPRECATED%5D+Search+across+knowledge.+Use+%2Fsearch%2Fai+for+AI-powered+generative+search+or+%2Fsearch%2Ftree+for+merged+context+tree+results.\u0026amp;theme=93e855688d813180906429a5\u0026amp;signature=0a03ed024ad7796ac3ce7aa83d058d118f137b1fb2a8d6dd9ec415428413deae\">\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/search/search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/search/search.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/search/search#webpage\",\"url\":\"https://developers.datagrid.com/api-reference/search/search\",\"name\":\"Search\",\"description\":\"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.\",\"dateModified\":\"2026-04-01T12:28:34.539Z\",\"isPartOf\":{\"@id\":\"https://developers.datagrid.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.datagrid.com/api-reference/search/search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.datagrid.com/api-reference/search/search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Datagrid AI\",\"item\":\"https://developers.datagrid.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search\",\"item\":\"https://developers.datagrid.com/api-reference/search/search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.datagrid.com/api-reference/search/search#apireference\",\"headline\":\"Search\",\"name\":\"Search\",\"description\":\"[DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results.\",\"url\":\"https://developers.datagrid.com/api-reference/search/search\",\"mainEntityOfPage\":{\"@id\":\"https://developers.datagrid.com/api-reference/search/search#webpage\"},\"dateModified\":\"2026-04-01T12:28:34.539Z\",\"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","description":"Retrieves the credentials (private key) for a service account.","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","description":"Search across your teamspace's indexed knowledge and return results as a hierarchical context tree.\nResults are grouped by source (datasets, files, pages) with navigation items for quick access.\nSupports pagination via cursor-based `next` parameter.\nThis endpoint is the foundation for the AI Search endpoint — use this when you need structured results without AI summarization.\n","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","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","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":"Search - 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"]}