IANA timezone identifier (e.g. "America/New_York") for resolving relative
time references like "today" or "last week". Unknown identifiers are rejected.
Defaults to America/New_York when omitted.
Restrict the evidence the model can ground its answer in to rows whose metadata contains ALL the given key/value pairs. Shorthand for a filter whose must lists each pair; combines with filter when both are set. Max 20 keys; string values only.
Boolean scope over items. Conditions test a field: source (source type such as email, slack_message, calendar_event, or a custom kind), connection (the connected account or custom connector, such as gmail:acme), timestamp (a date range), or any metadata tag you set at ingest on custom-connector items. must is AND, should is OR, must_not is NOT; nest a filter condition to group. Max depth 3. Example: emails and meetings from Q1 2026 in either of two accounts, excluding items tagged restricted. Any scope switches the answer to evidence retrieval only, so the model searches and reads matching records instead of querying your knowledge graph.
True when citations was capped — your answer drew on more supporting
records than are returned. The omitted records are similar in shape to
the ones present; refine your query if you need them enumerated.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Adapter","colors":{"primary":"#8765F0","light":"#8765F0","dark":"#8765F0"},"logo":{"light":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/light.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=459bd6410eb825d264414176cd7eba07","dark":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/dark.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=0bed0f3d3311b99106ba98e43a63d5e2"},"favicon":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/favicon.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=83406b22c16edb6994e5b28b146a7446","api":{"openapi":"api-reference/openapi.json","playground":{}},"background":{"color":{"light":"#F2F2F0","dark":"#171717"}},"navbar":{"links":[{"href":"mailto:support@adapter.com","label":"Support"}],"primary":{"type":"button","label":"Sign In","href":"https://mind.adapter.com"}},"footer":{"socials":{"x":"https://x.com/adapter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"adapter","hasAudioNarration":false,"actualSubdomain":"adapter","customDomains":["docs.beta.adapter.com"],"gitSource":{"type":"github","owner":"adapter-group","repo":"adapter-platform","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae23bb95db1d64f77da812c","collectionId":"3e863929-e534-43f8-bffd-cc13d5f5a900","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae23bb95db1d64f77da812c"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae23bb95db1d64f77da812c","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Knowledge","count":11},{"language":"default","tag":"Triggers","count":10},{"language":"default","tag":"Core Concepts","count":7},{"language":"default","tag":"Ingestion","count":6},{"language":"default","tag":"Custom Connectors","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Connectors","count":3},{"language":"default","tag":"Data","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/knowledge/ask","slug":"/api-reference/knowledge/ask","pageMetadata":{"title":"Ask","openapi":"POST /v1/knowledge/ask","description":"Ask a question and get a grounded answer with citations from connected data.","href":"/api-reference/knowledge/ask"},"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: \"Ask a question and get a grounded answer with citations from connected data.\"\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":{"title":"Ask","openapi":"POST /v1/knowledge/ask","description":"Ask a question and get a grounded answer with citations from connected data.","href":"/api-reference/knowledge/ask"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["knowledge"],"summary":"Ask","description":"Ask a question and get a grounded answer with citations from connected data.","operationId":"ask","requestBody":"0aac2f34-5139-4f40-ba7c-00d0b2314e81","responses":{"200":"1415e4a6-3c51-42d3-8ee8-3b0e7e8b2df2","401":"039843ad-5bef-4c6d-809b-b27bafcc922c","402":"7cd81773-d097-4fa1-afc1-f3ba2fc95c6c","403":"5d0f248f-889e-4f9a-b48b-4de2379f82e2","422":"af99b7a6-028b-4747-a281-12ddee201dcb","429":"1ee144e8-cb0c-4b89-b31a-8482997ae890","500":"b59f2be1-460a-4122-9f27-842b76b943a3","503":"1dd3639a-4ca5-43e4-9a8a-a75553cb4134"},"x-timeout-ms":240000,"method":"post","type":"path","servers":["b45a6dfc-eec4-42ae-a72a-9361a1098054"],"security":[],"path":"/v1/knowledge/ask","baseUrlOptions":["http://localhost:8080"],"title":"Ask","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","maxLength":16000,"minLength":1,"title":"Query","examples":["What are our top blockers for Q1?"],"isRequired":true,"uniqueKey":"query","typeLabel":"string"},"timezone":{"type":"string","title":"Timezone","description":"IANA timezone identifier (e.g. \"America/New_York\") for resolving relative\ntime references like \"today\" or \"last week\". Unknown identifiers are rejected.\nDefaults to America/New_York when omitted.","format":"iana-timezone","example":"America/New_York","uniqueKey":"timezone","typeLabel":"string\u003ciana-timezone>"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Restrict the evidence the model can ground its answer in to rows whose `metadata` contains ALL the given key/value pairs. Shorthand for a `filter` whose `must` lists each pair; combines with `filter` when both are set. Max 20 keys; string values only.","maxProperties":20,"example":{"env":"staging"},"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Restrict the evidence the model can ground its answer in to rows whose `metadata` contains ALL the given key/value pairs. Shorthand for a `filter` whose `must` lists each pair; combines with `filter` when both are set. Max 20 keys; string values only.","example":{"env":"staging"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"},"filter":{"oneOf":[{"type":"object","title":"EvidenceFilter","description":"Boolean scope over items. Conditions test a field: `source` (source type such as `email`, `slack_message`, `calendar_event`, or a custom kind), `connection` (the connected account or custom connector, such as `gmail:acme`), `timestamp` (a date range), or any metadata tag you set at ingest on custom-connector items. `must` is AND, `should` is OR, `must_not` is NOT; nest a `filter` condition to group. Max depth 3. Example: emails and meetings from Q1 2026 in either of two accounts, excluding items tagged restricted. Any scope switches the answer to evidence retrieval only, so the model searches and reads matching records instead of querying your knowledge graph.","example":{"must":[{"key":"source","match":{"any":["email","calendar_event"]}},{"key":"timestamp","range":{"gte":"2026-01-01","lte":"2026-03-31"}}],"must_not":[{"key":"sensitivity","match":{"value":"restricted"}}],"should":[{"key":"connection","match":{"value":"gmail:acme"}},{"key":"connection","match":{"value":"slack:acme"}}]},"properties":{"must":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"FilterCondition1","description":"Match on `source` (evidence type, e.g. `email`), `connection` (source\nprovider id, e.g. `gmail:acme`), or any metadata key set at ingest.","required":["key","match"],"properties":{"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.key","typeLabel":"string"},"match":{"oneOf":[{"type":"object","title":"FieldMatch1","required":["value"],"properties":{"value":{"type":"string","title":"Value","isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.0","typeLabel":"FieldMatch1 · object"},{"type":"object","title":"FieldMatch2","required":["any"],"properties":{"any":{"items":{"type":"string","uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1.any.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Any","isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1.any","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1","typeLabel":"FieldMatch2 · object"},{"type":"object","title":"FieldMatch3","required":["none"],"properties":{"none":{"items":{"type":"string","uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2.none.items.[INDEX]","typeLabel":"string"},"type":"array","title":"None","isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2.none","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2","typeLabel":"FieldMatch3 · object"}],"isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0.match","typeLabel":"FieldMatch1 · object | FieldMatch2 · object | FieldMatch3 · object"}},"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"FilterCondition1 · object"},{"type":"object","title":"FilterCondition2","description":"Inclusive bounds on the reserved `timestamp` field.","required":["key","range"],"properties":{"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.key","typeLabel":"string"},"range":{"properties":{"gte":{"oneOf":[{"type":"string","title":"Gte","uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range.gte.oneOf.0","typeLabel":"string"},{"type":"null","title":"Gte","uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range.gte.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range.gte","typeLabel":"string | null"},"lte":{"oneOf":[{"type":"string","title":"Lte","uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range.lte.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lte","uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range.lte.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range.lte","typeLabel":"string | null"}},"type":"object","title":"TimeRange","isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1.range","typeLabel":"TimeRange · object"}},"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"FilterCondition2 · object"},{"type":"object","title":"FilterCondition3","description":"A nested filter, for grouping.","required":["filter"],"properties":{"filter":{"oneOf":[{"$circularRef":"fe769cdc-949d-4b12-a5a3-e98181eb8587","isRequired":true}],"isRequired":true,"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.2.filter","typeLabel":"any"}},"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"FilterCondition3 · object"}],"uniqueKey":"filter.oneOf.0.must.oneOf.0.items.[INDEX]","typeLabel":"FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object"},"title":"Must","description":"Every condition must match.","uniqueKey":"filter.oneOf.0.must.oneOf.0","typeLabel":"(FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object)[]"},{"type":"null","title":"Must","description":"Every condition must match.","uniqueKey":"filter.oneOf.0.must.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.must","typeLabel":"(FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object)[] | null"},"must_not":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"FilterCondition1","description":"Match on `source` (evidence type, e.g. `email`), `connection` (source\nprovider id, e.g. `gmail:acme`), or any metadata key set at ingest.","required":["key","match"],"properties":{"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.key","typeLabel":"string"},"match":{"oneOf":[{"type":"object","title":"FieldMatch1","required":["value"],"properties":{"value":{"type":"string","title":"Value","isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.0","typeLabel":"FieldMatch1 · object"},{"type":"object","title":"FieldMatch2","required":["any"],"properties":{"any":{"items":{"type":"string","uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1.any.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Any","isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1.any","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1","typeLabel":"FieldMatch2 · object"},{"type":"object","title":"FieldMatch3","required":["none"],"properties":{"none":{"items":{"type":"string","uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2.none.items.[INDEX]","typeLabel":"string"},"type":"array","title":"None","isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2.none","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2","typeLabel":"FieldMatch3 · object"}],"isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0.match","typeLabel":"FieldMatch1 · object | FieldMatch2 · object | FieldMatch3 · object"}},"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"FilterCondition1 · object"},{"type":"object","title":"FilterCondition2","description":"Inclusive bounds on the reserved `timestamp` field.","required":["key","range"],"properties":{"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.key","typeLabel":"string"},"range":{"properties":{"gte":{"oneOf":[{"type":"string","title":"Gte","uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range.gte.oneOf.0","typeLabel":"string"},{"type":"null","title":"Gte","uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range.gte.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range.gte","typeLabel":"string | null"},"lte":{"oneOf":[{"type":"string","title":"Lte","uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range.lte.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lte","uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range.lte.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range.lte","typeLabel":"string | null"}},"type":"object","title":"TimeRange","isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1.range","typeLabel":"TimeRange · object"}},"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"FilterCondition2 · object"},{"type":"object","title":"FilterCondition3","description":"A nested filter, for grouping.","required":["filter"],"properties":{"filter":{"oneOf":[{"$circularRef":"fe769cdc-949d-4b12-a5a3-e98181eb8587","isRequired":true}],"isRequired":true,"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.2.filter","typeLabel":"any"}},"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"FilterCondition3 · object"}],"uniqueKey":"filter.oneOf.0.must_not.oneOf.0.items.[INDEX]","typeLabel":"FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object"},"title":"Must Not","description":"No condition may match. Rows without metadata pass metadata conditions here.","uniqueKey":"filter.oneOf.0.must_not.oneOf.0","typeLabel":"(FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object)[]"},{"type":"null","title":"Must Not","description":"No condition may match. Rows without metadata pass metadata conditions here.","uniqueKey":"filter.oneOf.0.must_not.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.must_not","typeLabel":"(FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object)[] | null"},"should":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"FilterCondition1","description":"Match on `source` (evidence type, e.g. `email`), `connection` (source\nprovider id, e.g. `gmail:acme`), or any metadata key set at ingest.","required":["key","match"],"properties":{"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.key","typeLabel":"string"},"match":{"oneOf":[{"type":"object","title":"FieldMatch1","required":["value"],"properties":{"value":{"type":"string","title":"Value","isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.0","typeLabel":"FieldMatch1 · object"},{"type":"object","title":"FieldMatch2","required":["any"],"properties":{"any":{"items":{"type":"string","uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1.any.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Any","isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1.any","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.1","typeLabel":"FieldMatch2 · object"},{"type":"object","title":"FieldMatch3","required":["none"],"properties":{"none":{"items":{"type":"string","uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2.none.items.[INDEX]","typeLabel":"string"},"type":"array","title":"None","isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2.none","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match.oneOf.2","typeLabel":"FieldMatch3 · object"}],"isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0.match","typeLabel":"FieldMatch1 · object | FieldMatch2 · object | FieldMatch3 · object"}},"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"FilterCondition1 · object"},{"type":"object","title":"FilterCondition2","description":"Inclusive bounds on the reserved `timestamp` field.","required":["key","range"],"properties":{"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.key","typeLabel":"string"},"range":{"properties":{"gte":{"oneOf":[{"type":"string","title":"Gte","uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range.gte.oneOf.0","typeLabel":"string"},{"type":"null","title":"Gte","uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range.gte.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range.gte","typeLabel":"string | null"},"lte":{"oneOf":[{"type":"string","title":"Lte","uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range.lte.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lte","uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range.lte.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range.lte","typeLabel":"string | null"}},"type":"object","title":"TimeRange","isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1.range","typeLabel":"TimeRange · object"}},"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"FilterCondition2 · object"},{"type":"object","title":"FilterCondition3","description":"A nested filter, for grouping.","required":["filter"],"properties":{"filter":{"oneOf":[{"$circularRef":"fe769cdc-949d-4b12-a5a3-e98181eb8587","isRequired":true}],"isRequired":true,"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.2.filter","typeLabel":"any"}},"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"FilterCondition3 · object"}],"uniqueKey":"filter.oneOf.0.should.oneOf.0.items.[INDEX]","typeLabel":"FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object"},"title":"Should","description":"At least one condition must match. Ignored when empty.","uniqueKey":"filter.oneOf.0.should.oneOf.0","typeLabel":"(FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object)[]"},{"type":"null","title":"Should","description":"At least one condition must match. Ignored when empty.","uniqueKey":"filter.oneOf.0.should.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter.oneOf.0.should","typeLabel":"(FilterCondition1 · object | FilterCondition2 · object | FilterCondition3 · object)[] | null"}},"uniqueKey":"filter.oneOf.0","typeLabel":"EvidenceFilter · object"},{"type":"null","description":"Boolean scope over items. Conditions test a field: `source` (source type such as `email`, `slack_message`, `calendar_event`, or a custom kind), `connection` (the connected account or custom connector, such as `gmail:acme`), `timestamp` (a date range), or any metadata tag you set at ingest on custom-connector items. `must` is AND, `should` is OR, `must_not` is NOT; nest a `filter` condition to group. Max depth 3. Example: emails and meetings from Q1 2026 in either of two accounts, excluding items tagged restricted. Any scope switches the answer to evidence retrieval only, so the model searches and reads matching records instead of querying your knowledge graph.","example":{"must":[{"key":"source","match":{"any":["email","calendar_event"]}},{"key":"timestamp","range":{"gte":"2026-01-01","lte":"2026-03-31"}}],"must_not":[{"key":"sensitivity","match":{"value":"restricted"}}],"should":[{"key":"connection","match":{"value":"gmail:acme"}},{"key":"connection","match":{"value":"slack:acme"}}]},"uniqueKey":"filter.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter","typeLabel":"EvidenceFilter · object | null"}},"additionalProperties":false,"type":"object","required":["query"],"title":"PublicAskRequest","uniqueKey":"","typeLabel":"PublicAskRequest · object"},"examples":{"Example":{"title":"Example","value":{"query":"What are our top blockers for Q1?","timezone":"America/New_York","metadata":{"env":"staging"},"filter":{"must":[{"key":"source","match":{"any":["email","calendar_event"]}},{"key":"timestamp","range":{"gte":"2026-01-01","lte":"2026-03-31"}}],"must_not":[{"key":"sensitivity","match":{"value":"restricted"}}],"should":[{"key":"connection","match":{"value":"gmail:acme"}},{"key":"connection","match":{"value":"slack:acme"}}]}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"1415e4a6-3c51-42d3-8ee8-3b0e7e8b2df2":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"AskResponse","required":["citations","form","metadata","response","truncated"],"properties":{"citations":{"items":{"properties":{"entity":{"additionalProperties":true,"type":"object","title":"Entity","isRequired":true,"uniqueKey":"oneOf.0.citations.items.[INDEX].entity","typeLabel":"Entity · object"},"type":{"type":"string","title":"Type","isRequired":true,"uniqueKey":"oneOf.0.citations.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["entity","type"],"title":"Citation","description":"A citation grounding the answer in a specific entity from your connected\ndata. `type` is the entity type (e.g. \"person\", \"calendar_event\",\n\"receipt\") — citations in one response typically span multiple types.\n`entity` carries the full hydrated record so clients render it without a\nsecond lookup.","uniqueKey":"oneOf.0.citations.items.[INDEX]","typeLabel":"Citation · object"},"type":"array","title":"Citations","description":"Per-record citations grounding the output.","isRequired":true,"uniqueKey":"oneOf.0.citations","typeLabel":"Citation · object[]"},"form":{"type":"string","enum":["chat","report"],"title":"AskForm","description":"The `form` the request asked for, echoed.","isRequired":true,"uniqueKey":"oneOf.0.form","typeLabel":"enum\u003cstring>"},"metadata":{"properties":{"total_examined":{"type":"integer","minimum":0,"title":"Total Examined","description":"How many entities were seen during answering.","isRequired":true,"uniqueKey":"oneOf.0.metadata.total_examined","typeLabel":"integer"},"usage":{"properties":{"generation":{"properties":{"cache_creation_input_tokens":{"type":"integer","minimum":0,"title":"Cache Creation Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.generation.cache_creation_input_tokens","typeLabel":"integer"},"cache_read_input_tokens":{"type":"integer","minimum":0,"title":"Cache Read Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.generation.cache_read_input_tokens","typeLabel":"integer"},"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.generation.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.generation.output_tokens","typeLabel":"integer"}},"type":"object","required":["cache_creation_input_tokens","cache_read_input_tokens","input_tokens","output_tokens"],"title":"TokenCounts","description":"Answer generation phase.","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.generation","typeLabel":"TokenCounts · object"},"planning":{"properties":{"cache_creation_input_tokens":{"type":"integer","minimum":0,"title":"Cache Creation Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.planning.cache_creation_input_tokens","typeLabel":"integer"},"cache_read_input_tokens":{"type":"integer","minimum":0,"title":"Cache Read Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.planning.cache_read_input_tokens","typeLabel":"integer"},"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.planning.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.planning.output_tokens","typeLabel":"integer"}},"type":"object","required":["cache_creation_input_tokens","cache_read_input_tokens","input_tokens","output_tokens"],"title":"TokenCounts","description":"Planning and query phase.","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.planning","typeLabel":"TokenCounts · object"},"total":{"properties":{"cache_creation_input_tokens":{"type":"integer","minimum":0,"title":"Cache Creation Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.total.cache_creation_input_tokens","typeLabel":"integer"},"cache_read_input_tokens":{"type":"integer","minimum":0,"title":"Cache Read Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.total.cache_read_input_tokens","typeLabel":"integer"},"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.total.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.total.output_tokens","typeLabel":"integer"}},"type":"object","required":["cache_creation_input_tokens","cache_read_input_tokens","input_tokens","output_tokens"],"title":"TokenCounts","description":"All phases combined.","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage.total","typeLabel":"TokenCounts · object"}},"type":"object","required":["generation","planning","total"],"title":"AskUsage","description":"Token usage for this answer.","isRequired":true,"uniqueKey":"oneOf.0.metadata.usage","typeLabel":"AskUsage · object"},"examined":{"oneOf":[{"type":"array","items":{"properties":{"access_count":{"type":"integer","minimum":0,"title":"Access Count","description":"Times a tool call surfaced this record. This is intentionally loose\nproduct-compatible accounting: cancellation can mean a surfaced record\nwas not delivered to a model call.","isRequired":true,"uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX].access_count","typeLabel":"integer"},"cited":{"type":"boolean","title":"Cited","description":"The final answer cited this record (matched by id or urn).","isRequired":true,"uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX].cited","typeLabel":"boolean"},"id":{"type":"string","title":"Id","description":"Id as the agent saw it: a row `_id` from `execute_query`, or a search\nhit's `evidence_key`.","isRequired":true,"uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX].id","typeLabel":"string"},"urn":{"oneOf":[{"type":"string","title":"Urn","description":"URN, when the surfacing tool exposed one (search hits carry it).","uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX].urn.oneOf.0","typeLabel":"string"},{"type":"null","title":"Urn","description":"URN, when the surfacing tool exposed one (search hits carry it).","uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX].urn.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX].urn","typeLabel":"string | null"}},"type":"object","required":["access_count","cited","id"],"title":"ExaminedRecord","description":"**Experimental.** One record the agent examined while answering. Recorded\nserver-side at tool-execution time — never produced by the model.","uniqueKey":"oneOf.0.metadata.examined.oneOf.0.items.[INDEX]","typeLabel":"ExaminedRecord · object"},"title":"Examined","description":"**Experimental.** Present only when the request set `include_examined`.\nSorted cited-first, then individually-read, then latest-seen, then\nmost-accessed; capped at 200 entries (`total_examined` is the uncapped\ncount).","uniqueKey":"oneOf.0.metadata.examined.oneOf.0","typeLabel":"ExaminedRecord · object[]"},{"type":"null","title":"Examined","description":"**Experimental.** Present only when the request set `include_examined`.\nSorted cited-first, then individually-read, then latest-seen, then\nmost-accessed; capped at 200 entries (`total_examined` is the uncapped\ncount).","uniqueKey":"oneOf.0.metadata.examined.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata.examined","typeLabel":"ExaminedRecord · object[] | null"}},"type":"object","required":["total_examined","usage"],"title":"AskMetadata","description":"Observability for this answer.","isRequired":true,"uniqueKey":"oneOf.0.metadata","typeLabel":"AskMetadata · object"},"response":{"type":"string","title":"Response","description":"Output generated for your query.","isRequired":true,"uniqueKey":"oneOf.0.response","typeLabel":"string"},"truncated":{"type":"boolean","title":"Truncated","description":"True when `citations` was capped — your answer drew on more supporting\nrecords than are returned. The omitted records are similar in shape to\nthe ones present; refine your query if you need them enumerated.","isRequired":true,"uniqueKey":"oneOf.0.truncated","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"AskResponse · object"},{"type":"object","title":"ProcessingResponse","description":"Returned with 202 Accepted while your data is still being contextualized and\nis not yet ready to answer. Processing continues automatically; retry after\n`retry_after_seconds`.","required":["message","retry_after_seconds","status"],"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"retry_after_seconds":{"type":"integer","minimum":0,"title":"Retry After Seconds","isRequired":true,"uniqueKey":"oneOf.1.retry_after_seconds","typeLabel":"integer"},"status":{"type":"string","title":"Status","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"ProcessingResponse · object"}],"uniqueKey":"","typeLabel":"AskResponse · object | ProcessingResponse · object"},"examples":{"Example":{"title":"Example","value":{"citations":[{"entity":{},"type":"\u003cstring>"}],"form":"chat","metadata":{"total_examined":1,"usage":{"generation":{"cache_creation_input_tokens":1,"cache_read_input_tokens":1,"input_tokens":1,"output_tokens":1},"planning":{"cache_creation_input_tokens":1,"cache_read_input_tokens":1,"input_tokens":1,"output_tokens":1},"total":{"cache_creation_input_tokens":1,"cache_read_input_tokens":1,"input_tokens":1,"output_tokens":1}},"examined":[{"access_count":1,"cited":true,"id":"\u003cstring>","urn":"\u003cstring>"}]},"response":"\u003cstring>","truncated":true}}},"exampleType":"generated"}},"exampleType":"generated"},"039843ad-5bef-4c6d-809b-b27bafcc922c":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"authentication_error","title":"Error Code","default":"authentication_error","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"Invalid or missing credentials.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"AuthenticationErrorModel","uniqueKey":"","typeLabel":"AuthenticationErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"authentication_error","message":"Invalid or missing credentials.","details":{}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"7cd81773-d097-4fa1-afc1-f3ba2fc95c6c":{"description":"Ask refused — the workspace has used every ask its plan includes. The allowance never resets; upgrade rather than retry.","content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"quota_exceeded","title":"Error Code","default":"quota_exceeded","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"Ask refused: this workspace has used all the asks its plan includes.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Carries `resource` (`\"asks\"`) and `limit`, the asks the plan includes.","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Carries `resource` (`\"asks\"`) and `limit`, the asks the plan includes.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"AskQuotaExceededErrorModel","uniqueKey":"","typeLabel":"AskQuotaExceededErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"quota_exceeded","message":"Ask refused: this workspace has used all the asks its plan includes.","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"5d0f248f-889e-4f9a-b48b-4de2379f82e2":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"permission_denied","title":"Error Code","default":"permission_denied","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"You do not have permission to perform this action.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"PermissionDeniedErrorModel","uniqueKey":"","typeLabel":"PermissionDeniedErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"permission_denied","message":"You do not have permission to perform this action.","details":{}}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"af99b7a6-028b-4747-a281-12ddee201dcb":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1ee144e8-cb0c-4b89-b31a-8482997ae890":{"description":"Rate limit exceeded for the caller's tier. RFC 9457 problem+json body; IETF RateLimit-* headers and Retry-After are set.","headers":{"Retry-After":{"description":"Seconds to wait before retrying (RFC 9110).","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requests allowed per window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Delta-seconds until the window resets.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"Active policy, e.g. '5;w=60'.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"properties":{"type":{"type":"string","title":"Type","description":"Stable problem-type URI, e.g. '{api_base_url}/errors/rate_limit_exceeded'.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","title":"Detail","description":"Human-readable explanation, including the retry hint.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"endpoint":{"type":"string","title":"Endpoint","description":"Logical endpoint the limit applies to (e.g. 'ask', 'search').","isRequired":true,"uniqueKey":"endpoint","typeLabel":"string"},"tier":{"type":"string","title":"Tier","description":"The caller's billing tier (e.g. 'flex').","isRequired":true,"uniqueKey":"tier","typeLabel":"string"},"limit":{"type":"integer","title":"Limit","description":"Requests allowed per window for this tier + endpoint.","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"},"remaining":{"type":"integer","title":"Remaining","description":"Requests remaining in the current window (0 when blocked).","isRequired":true,"uniqueKey":"remaining","typeLabel":"integer"},"window_seconds":{"type":"integer","title":"Window Seconds","description":"Length of the fixed rate-limit window, in seconds.","isRequired":true,"uniqueKey":"window_seconds","typeLabel":"integer"},"retry_after":{"type":"integer","title":"Retry After","description":"Seconds to wait before retrying (mirrors the Retry-After header).","isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer"},"title":{"type":"string","const":"Too Many Requests","title":"Title","default":"Too Many Requests","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","const":429,"title":"Status","default":429,"uniqueKey":"status","typeLabel":"integer"},"error_code":{"type":"string","const":"rate_limit_exceeded","title":"Error Code","default":"rate_limit_exceeded","uniqueKey":"error_code","typeLabel":"string"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"The request path that was limited.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"The request path that was limited.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"type":"object","required":["type","detail","endpoint","tier","limit","remaining","window_seconds","retry_after"],"title":"RateLimitProblemDetail","description":"The 429 response body, exactly as ``RateLimitError.problem_detail`` renders it —\nRFC 9457 Problem Details, served as ``application/problem+json`` alongside the IETF\n``RateLimit-*`` headers and ``Retry-After``. (Distinct from the legacy\n``RateLimitErrorModel`` shape, which does not match what the handler emits.)","uniqueKey":"","typeLabel":"RateLimitProblemDetail · object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","detail":"\u003cstring>","endpoint":"\u003cstring>","tier":"\u003cstring>","limit":123,"remaining":123,"window_seconds":123,"retry_after":123,"title":"Too Many Requests","status":429,"error_code":"rate_limit_exceeded","instance":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"properties":{"type":{"type":"string","title":"Type","description":"Stable problem-type URI, e.g. '{api_base_url}/errors/rate_limit_exceeded'.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","title":"Detail","description":"Human-readable explanation, including the retry hint.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"endpoint":{"type":"string","title":"Endpoint","description":"Logical endpoint the limit applies to (e.g. 'ask', 'search').","isRequired":true,"uniqueKey":"endpoint","typeLabel":"string"},"tier":{"type":"string","title":"Tier","description":"The caller's billing tier (e.g. 'flex').","isRequired":true,"uniqueKey":"tier","typeLabel":"string"},"limit":{"type":"integer","title":"Limit","description":"Requests allowed per window for this tier + endpoint.","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"},"remaining":{"type":"integer","title":"Remaining","description":"Requests remaining in the current window (0 when blocked).","isRequired":true,"uniqueKey":"remaining","typeLabel":"integer"},"window_seconds":{"type":"integer","title":"Window Seconds","description":"Length of the fixed rate-limit window, in seconds.","isRequired":true,"uniqueKey":"window_seconds","typeLabel":"integer"},"retry_after":{"type":"integer","title":"Retry After","description":"Seconds to wait before retrying (mirrors the Retry-After header).","isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer"},"title":{"type":"string","const":"Too Many Requests","title":"Title","default":"Too Many Requests","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","const":429,"title":"Status","default":429,"uniqueKey":"status","typeLabel":"integer"},"error_code":{"type":"string","const":"rate_limit_exceeded","title":"Error Code","default":"rate_limit_exceeded","uniqueKey":"error_code","typeLabel":"string"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"The request path that was limited.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"The request path that was limited.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"type":"object","required":["type","detail","endpoint","tier","limit","remaining","window_seconds","retry_after"],"title":"RateLimitProblemDetail","description":"The 429 response body, exactly as ``RateLimitError.problem_detail`` renders it —\nRFC 9457 Problem Details, served as ``application/problem+json`` alongside the IETF\n``RateLimit-*`` headers and ``Retry-After``. (Distinct from the legacy\n``RateLimitErrorModel`` shape, which does not match what the handler emits.)","uniqueKey":"","typeLabel":"RateLimitProblemDetail · object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","detail":"\u003cstring>","endpoint":"\u003cstring>","tier":"\u003cstring>","limit":123,"remaining":123,"window_seconds":123,"retry_after":123,"title":"Too Many Requests","status":429,"error_code":"rate_limit_exceeded","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b59f2be1-460a-4122-9f27-842b76b943a3":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"internal_server_error","title":"Error Code","default":"internal_server_error","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"An unexpected error occurred.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"InternalServerErrorModel","uniqueKey":"","typeLabel":"InternalServerErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"internal_server_error","message":"An unexpected error occurred.","details":{}}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"},"1dd3639a-4ca5-43e4-9a8a-a75553cb4134":{"description":"Service Unavailable","content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"service_unavailable","title":"Error Code","default":"service_unavailable","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"The service is currently experiencing issues. Please try again later.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"ServiceUnavailableErrorModel","uniqueKey":"","typeLabel":"ServiceUnavailableErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"service_unavailable","message":"The service is currently experiencing issues. Please try again later.","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"b45a6dfc-eec4-42ae-a72a-9361a1098054":{"url":"http://localhost:8080"}},"schemas":{"fe769cdc-949d-4b12-a5a3-e98181eb8587":{"properties":{"must":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"FilterCondition1","description":"Match on `source` (evidence type, e.g. `email`), `connection` (source\nprovider id, e.g. `gmail:acme`), or any metadata key set at ingest.","required":["key","match"],"properties":{"key":{"type":"string","title":"Key","isRequired":true},"match":{"oneOf":[{"type":"object","title":"FieldMatch1","required":["value"],"properties":{"value":{"type":"string","title":"Value","isRequired":true}},"isRequired":true},{"type":"object","title":"FieldMatch2","required":["any"],"properties":{"any":{"items":{"type":"string"},"type":"array","title":"Any","isRequired":true}},"isRequired":true},{"type":"object","title":"FieldMatch3","required":["none"],"properties":{"none":{"items":{"type":"string"},"type":"array","title":"None","isRequired":true}},"isRequired":true}],"isRequired":true}}},{"type":"object","title":"FilterCondition2","description":"Inclusive bounds on the reserved `timestamp` field.","required":["key","range"],"properties":{"key":{"type":"string","title":"Key","isRequired":true},"range":{"properties":{"gte":{"oneOf":[{"type":"string","title":"Gte"},{"type":"null","title":"Gte"}]},"lte":{"oneOf":[{"type":"string","title":"Lte"},{"type":"null","title":"Lte"}]}},"type":"object","title":"TimeRange","isRequired":true}}},{"type":"object","title":"FilterCondition3","description":"A nested filter, for grouping.","required":["filter"],"properties":{"filter":{"oneOf":[{"isRequired":true}],"isRequired":true}}}]},"title":"Must","description":"Every condition must match."},{"type":"null","title":"Must","description":"Every condition must match."}]},"must_not":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"FilterCondition1","description":"Match on `source` (evidence type, e.g. `email`), `connection` (source\nprovider id, e.g. `gmail:acme`), or any metadata key set at ingest.","required":["key","match"],"properties":{"key":{"type":"string","title":"Key","isRequired":true},"match":{"oneOf":[{"type":"object","title":"FieldMatch1","required":["value"],"properties":{"value":{"type":"string","title":"Value","isRequired":true}},"isRequired":true},{"type":"object","title":"FieldMatch2","required":["any"],"properties":{"any":{"items":{"type":"string"},"type":"array","title":"Any","isRequired":true}},"isRequired":true},{"type":"object","title":"FieldMatch3","required":["none"],"properties":{"none":{"items":{"type":"string"},"type":"array","title":"None","isRequired":true}},"isRequired":true}],"isRequired":true}}},{"type":"object","title":"FilterCondition2","description":"Inclusive bounds on the reserved `timestamp` field.","required":["key","range"],"properties":{"key":{"type":"string","title":"Key","isRequired":true},"range":{"properties":{"gte":{"oneOf":[{"type":"string","title":"Gte"},{"type":"null","title":"Gte"}]},"lte":{"oneOf":[{"type":"string","title":"Lte"},{"type":"null","title":"Lte"}]}},"type":"object","title":"TimeRange","isRequired":true}}},{"type":"object","title":"FilterCondition3","description":"A nested filter, for grouping.","required":["filter"],"properties":{"filter":{"oneOf":[{"isRequired":true}],"isRequired":true}}}]},"title":"Must Not","description":"No condition may match. Rows without metadata pass metadata conditions here."},{"type":"null","title":"Must Not","description":"No condition may match. Rows without metadata pass metadata conditions here."}]},"should":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"FilterCondition1","description":"Match on `source` (evidence type, e.g. `email`), `connection` (source\nprovider id, e.g. `gmail:acme`), or any metadata key set at ingest.","required":["key","match"],"properties":{"key":{"type":"string","title":"Key","isRequired":true},"match":{"oneOf":[{"type":"object","title":"FieldMatch1","required":["value"],"properties":{"value":{"type":"string","title":"Value","isRequired":true}},"isRequired":true},{"type":"object","title":"FieldMatch2","required":["any"],"properties":{"any":{"items":{"type":"string"},"type":"array","title":"Any","isRequired":true}},"isRequired":true},{"type":"object","title":"FieldMatch3","required":["none"],"properties":{"none":{"items":{"type":"string"},"type":"array","title":"None","isRequired":true}},"isRequired":true}],"isRequired":true}}},{"type":"object","title":"FilterCondition2","description":"Inclusive bounds on the reserved `timestamp` field.","required":["key","range"],"properties":{"key":{"type":"string","title":"Key","isRequired":true},"range":{"properties":{"gte":{"oneOf":[{"type":"string","title":"Gte"},{"type":"null","title":"Gte"}]},"lte":{"oneOf":[{"type":"string","title":"Lte"},{"type":"null","title":"Lte"}]}},"type":"object","title":"TimeRange","isRequired":true}}},{"type":"object","title":"FilterCondition3","description":"A nested filter, for grouping.","required":["filter"],"properties":{"filter":{"oneOf":[{"isRequired":true}],"isRequired":true}}}]},"title":"Should","description":"At least one condition must match. Ignored when empty."},{"type":"null","title":"Should","description":"At least one condition must match. Ignored when empty."}]}},"type":"object","title":"EvidenceFilter"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"adapter","siteName":"Adapter","title":"Ask - Adapter","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-20T21:36:38.106Z","originalFileLocation":"api-reference/knowledge/ask.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=\"Ask a question and get a grounded answer with citations from connected data.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Adapter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_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/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Ask - Adapter\">\u003cmeta data-mint-head property=\"og:description\" content=\"Ask a question and get a grounded answer with citations from connected data.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Adapter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beta.adapter.com/api-reference/knowledge/ask\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://adapter.mintlify.app/_mintlify/api/og/v2?division=Knowledge\u0026amp;title=Ask\u0026amp;description=Ask+a+question+and+get+a+grounded+answer+with+citations+from+connected+data.\u0026amp;theme=172df802757f1536c21dc595\u0026amp;signature=6736d12001bacdcd2444526e6f2d42e337c259e86dfdafc5db4b5a3a27776851\">\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=\"Ask - Adapter\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Ask a question and get a grounded answer with citations from connected data.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://adapter.mintlify.app/_mintlify/api/og/v2?division=Knowledge\u0026amp;title=Ask\u0026amp;description=Ask+a+question+and+get+a+grounded+answer+with+citations+from+connected+data.\u0026amp;theme=172df802757f1536c21dc595\u0026amp;signature=6736d12001bacdcd2444526e6f2d42e337c259e86dfdafc5db4b5a3a27776851\">\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/adapter/QFVp-gltrPnIPgdk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Adapter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8765F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beta.adapter.com/api-reference/knowledge/ask\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/knowledge/ask.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beta.adapter.com/#organization\",\"name\":\"Adapter\",\"url\":\"https://docs.beta.adapter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/light.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=459bd6410eb825d264414176cd7eba07\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beta.adapter.com#website\",\"name\":\"Adapter\",\"url\":\"https://docs.beta.adapter.com\",\"publisher\":{\"@id\":\"https://docs.beta.adapter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask#webpage\",\"url\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask\",\"name\":\"Ask\",\"description\":\"Ask a question and get a grounded answer with citations from connected data.\",\"dateModified\":\"2026-05-20T21:36:38.106Z\",\"isPartOf\":{\"@id\":\"https://docs.beta.adapter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knowledge\",\"item\":\"https://docs.beta.adapter.com/api-reference/knowledge/search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ask\",\"item\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask#apireference\",\"headline\":\"Ask\",\"name\":\"Ask\",\"description\":\"Ask a question and get a grounded answer with citations from connected data.\",\"url\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beta.adapter.com/api-reference/knowledge/ask#webpage\"},\"dateModified\":\"2026-05-20T21:36:38.106Z\",\"publisher\":{\"@id\":\"https://docs.beta.adapter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beta.adapter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Adapter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Adapter","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/getting-started/mcp"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Overview","href":"/api-reference/introduction"}]},{"group":"Connectors","expanded":false,"pages":[{"title":"List Connections","openapi":"GET /v1/connections","href":"/api-reference/connectors/list-connections"},{"title":"Get Connection","openapi":"GET /v1/connections/{connection_id}","href":"/api-reference/connectors/get-connection"},{"title":"List Resource Facets","openapi":"GET /v1/connections/{connection_id}/resources/{resource}/facets/{facet_name}","href":"/api-reference/connectors/list-resource-facets"}]},{"group":"Custom Connectors","expanded":false,"pages":[{"title":"List custom connectors","openapi":"GET /v1/custom-connectors","href":"/api-reference/custom-connectors/list-custom-connectors"},{"title":"Create a custom connector","openapi":"POST /v1/custom-connectors","href":"/api-reference/custom-connectors/create-custom-connector"},{"title":"Get a custom connector","openapi":"GET /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/get-custom-connector"},{"title":"Update a custom connector","openapi":"PATCH /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/update-custom-connector"},{"title":"Deactivate a custom connector","openapi":"DELETE /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/delete-custom-connector"}]},{"group":"Data","expanded":false,"pages":[{"title":"Download Document Raw","openapi":"GET /v1/data/{connection_id}/{resource}/raw/{external_id}","href":"/api-reference/data/download-document-raw"},{"title":"Get Document Detail","openapi":"GET /v1/data/{connection_id}/{resource}/{external_id}","href":"/api-reference/data/get-document-detail"}]},{"group":"Documents","expanded":false,"pages":[{"title":"Get Document By Urn","openapi":"GET /v1/documents/{urn}","href":"/api-reference/documents/get-document-by-urn"},{"title":"Download Document By Urn","openapi":"GET /v1/documents/{urn}/raw","href":"/api-reference/documents/download-document-by-urn"}]},{"group":"Ingestion","expanded":false,"pages":[{"title":"Ingest generic JSON events","openapi":"POST /v1/custom-connectors/{connector_id}/ingest","href":"/api-reference/ingestion/ingest-custom"},{"title":"Upload a binary as a generic event","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/upload","href":"/api-reference/ingestion/ingest-custom-upload"},{"title":"Start a presigned video upload","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/video/upload-url","href":"/api-reference/ingestion/ingest-video-upload-url"},{"title":"Finalize a presigned video upload","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/video/complete","href":"/api-reference/ingestion/ingest-video-complete"},{"title":"Ingest typed first-party events","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/typed","href":"/api-reference/ingestion/ingest-typed"},{"title":"Upload a binary as a typed event","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/typed/upload","href":"/api-reference/ingestion/ingest-typed-upload"}]},{"group":"Knowledge","expanded":false,"pages":[{"title":"Search","openapi":"POST /v1/knowledge/search","description":"Search across connected data sources. Returns ranked results with source metadata.","href":"/api-reference/knowledge/search"},{"title":"Ask","openapi":"POST /v1/knowledge/ask","href":"/api-reference/knowledge/ask"},{"title":"Ask Stream","openapi":"POST /v1/knowledge/ask/stream","description":"Ask a question and stream the answering","href":"/api-reference/knowledge/ask-stream"},{"title":"List Ask Jobs","openapi":"GET /v1/knowledge/ask/jobs","href":"/api-reference/knowledge/list-ask-jobs"},{"title":"Create Ask Job","openapi":"POST /v1/knowledge/ask/jobs","href":"/api-reference/knowledge/create-ask-job"},{"title":"Get Ask Job","openapi":"GET /v1/knowledge/ask/jobs/{job_id}","href":"/api-reference/knowledge/get-ask-job"},{"title":"Get Entity","openapi":"GET /v1/knowledge/entities/{entity_id}","href":"/api-reference/knowledge/get-entity"},{"title":"Refresh Context","openapi":"POST /v1/knowledge/refresh","href":"/api-reference/knowledge/refresh-context"},{"title":"Context Status","openapi":"GET /v1/knowledge/status","href":"/api-reference/knowledge/context-status"},{"title":"Get Knowledge Settings","openapi":"GET /v1/knowledge/settings","href":"/api-reference/knowledge/get-knowledge-settings"},{"title":"Update Knowledge Settings","openapi":"PATCH /v1/knowledge/settings","href":"/api-reference/knowledge/update-knowledge-settings"}]},{"group":"Triggers","expanded":false,"pages":[{"title":"List triggers","openapi":"GET /v1/triggers","href":"/api-reference/Triggers/list-triggers"},{"title":"Create trigger","openapi":"POST /v1/triggers","href":"/api-reference/Triggers/create-trigger"},{"title":"List trigger registry","openapi":"GET /v1/triggers/kinds","href":"/api-reference/Triggers/list-trigger-kinds"},{"title":"Get delivery counts","openapi":"GET /v1/triggers/deliveries/summary","href":"/api-reference/Triggers/get-trigger-delivery-summary"},{"title":"Get trigger details","openapi":"GET /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/get-trigger"},{"title":"Update trigger","openapi":"PATCH /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/update-trigger"},{"title":"Delete trigger","openapi":"DELETE /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/delete-trigger"},{"title":"List deliveries","openapi":"GET /v1/triggers/{trigger_id}/deliveries","href":"/api-reference/Triggers/list-trigger-deliveries"}]},{"group":"Writeback","expanded":false,"pages":[{"title":"Write agent output back into the workspace","openapi":"POST /v1/writeback","href":"/api-reference/writeback/write-back"},{"title":"Recently written-back items","openapi":"GET /v1/writeback/recent","href":"/api-reference/writeback/recent-writebacks"}]}]}]},"basePath":"","title":"Ask - Adapter","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}