If true, an english summary of the result in context of the original query will be returned.
Applies only when calling the query API and only available when stream=True
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aryn Documentation","description":"Aryn is an agentic unstructured data warehouse that enables deep analyitcs and seach on documents at scale.","colors":{"primary":"#417586","light":"#417586","dark":"#417586"},"logo":{"light":"https://mintcdn.com/aryn/NmC_FCDeIgvkLjlo/logo/aryn_logo_full.png?fit=max\u0026auto=format\u0026n=NmC_FCDeIgvkLjlo\u0026q=85\u0026s=a98c5e045ec1cf0148d9df24e5e6b97a","dark":"https://mintcdn.com/aryn/NmC_FCDeIgvkLjlo/logo/aryn_logo_full.png?fit=max\u0026auto=format\u0026n=NmC_FCDeIgvkLjlo\u0026q=85\u0026s=a98c5e045ec1cf0148d9df24e5e6b97a"},"favicon":"aryn_logo.png","background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:info@aryn.ai","label":"Get Support"},{"href":"https://aryn.instatus.com/","label":"Status Page"}],"primary":{"type":"button","label":"Website","href":"https://www.aryn.ai/"}},"footer":{"socials":{"x":"https://x.com/ArynInc","github":"https://github.com/aryn-ai","linkedin":"https://www.linkedin.com/company/aryn-ai"}},"seo":{"indexing":"all"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Aryn Blog","icon":"newspaper","href":"https://www.aryn.ai/blog"},{"anchor":"Slack Community","icon":"slack","href":"https://join.slack.com/t/aryn-community/shared_invite/zt-36vhennsx-mN3UsqD6PT2vxVZxpqdHsw"},{"anchor":"Sycamore - Document ETL","icon":"bars-staggered","href":"https://github.com/aryn-ai/sycamore"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aryn","hasAudioNarration":false,"actualSubdomain":"aryn","customDomains":["docs.aryn.ai"],"gitSource":{"type":"github","owner":"aryn-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21f617a51a213e6e8ae6a0","collectionId":"ec9289d9-c22b-4193-b659-b8e5c72c5200","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a21f617a51a213e6e8ae6a0:success","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"DocParse","count":41},{"language":"default","tag":"Aryn Platform","count":32},{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Deep Analytics (Preview)","count":12},{"language":"default","tag":"Tutorials","count":10},{"language":"default","tag":"Document","count":10},{"language":"default","tag":"DocSet","count":7},{"language":"default","tag":"Partition","count":5},{"language":"default","tag":"Querying Data","count":4},{"language":"default","tag":"Query","count":4}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@aryn.ai"}},"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":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/query/generate-plan","slug":"/api-reference/query/generate-plan","pageMetadata":{"title":"Generate Plan","description":"Generate a query plan for the given query, but do not run it.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query/plan","href":"/api-reference/query/generate-plan","autogeneratedByOpenApi":true,"hidden":false},"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: \"Generate a query plan for the given query, but do not run it.\"\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":"Generate Plan","description":"Generate a query plan for the given query, but do not run it.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query/plan","href":"/api-reference/query/generate-plan","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Query"],"summary":"Generate Plan","description":"Generate a query plan for the given query, but do not run it.","operationId":"generate_plan_v1_query_plan_post","requestBody":"60f307fa-1c5b-4005-a159-e2e375b983d3","responses":{"200":"1d1540e6-ba54-40be-90f5-d16c940de85f","404":"4ea35721-7072-4d0c-a0f8-870efde0b7b1","422":"0103d5bc-06fa-4e78-a655-a51c6ac8fb40"},"security":["156e71e5-394f-411c-9ec5-5e5cbc05d068"],"method":"post","type":"path","servers":["8f578b92-3513-451f-b34a-fce1ad6f83c3","8f62d6ca-6607-41db-84eb-8ccfc3ac24ec","bf169c67-b51a-48cb-b7ce-eb33167cd490","5f7a6f84-8d3c-4d22-b2cd-dab551ecd408"],"path":"/v1/query/plan","baseUrlOptions":["https://api.aryn.cloud","https://api.aryn.ai","https://api.us.aryn.cloud","https://api.us.aryn.ai"],"title":"Generate Plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"docset_id":{"oneOf":[{"type":"string","title":"Docset Id","description":"The docset against which to run the query","uniqueKey":"docset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Docset Id","description":"The docset against which to run the query","uniqueKey":"docset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"docset_id","typeLabel":"string | null"},"query":{"oneOf":[{"type":"string","title":"Query","description":"The natural language query to run. if specified, `plan` must not be set.","uniqueKey":"query.oneOf.0","typeLabel":"string"},{"type":"null","title":"Query","description":"The natural language query to run. if specified, `plan` must not be set.","uniqueKey":"query.oneOf.1","typeLabel":"null"}],"uniqueKey":"query","typeLabel":"string | null"},"plan":{"oneOf":[{"type":"object","title":"LogicalPlan","description":"The logical query plan to run. If specified, `query` must not be set.","required":["query","nodes","result_node"],"properties":{"query":{"type":"string","title":"Query","description":"The query that the plan is for.","isRequired":true,"uniqueKey":"plan.oneOf.0.query","typeLabel":"string"},"nodes":{"additionalProperties":{"properties":{"node_id":{"type":"integer","title":"Node Id","description":"A unique integer ID representing this node.","isRequired":true,"uniqueKey":"plan.oneOf.0.nodes.additionalProperties.node_id","typeLabel":"integer"},"node_type":{"oneOf":[{"type":"string","title":"Node Type","description":"The type of this node.","uniqueKey":"plan.oneOf.0.nodes.additionalProperties.node_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Node Type","description":"The type of this node.","uniqueKey":"plan.oneOf.0.nodes.additionalProperties.node_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.nodes.additionalProperties.node_type","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"A detailed description of why this operator was chosen for this query plan.","uniqueKey":"plan.oneOf.0.nodes.additionalProperties.description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"A detailed description of why this operator was chosen for this query plan.","uniqueKey":"plan.oneOf.0.nodes.additionalProperties.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.nodes.additionalProperties.description","typeLabel":"string | null"},"inputs":{"items":{"type":"integer","uniqueKey":"plan.oneOf.0.nodes.additionalProperties.inputs.items.[INDEX]","typeLabel":"integer"},"type":"array","title":"Inputs","description":"A list of node IDs that this operation depends on.","default":[],"uniqueKey":"plan.oneOf.0.nodes.additionalProperties.inputs","typeLabel":"integer[]"}},"additionalProperties":true,"type":"object","required":["node_id"],"title":"Node","description":"A single operation in a logical plan.","uniqueKey":"plan.oneOf.0.nodes.additionalProperties","typeLabel":"Node · object"},"type":"object","title":"Nodes","description":"A mapping of node IDs to nodes in the query plan.","isRequired":true,"uniqueKey":"plan.oneOf.0.nodes","typeLabel":"Nodes · object"},"result_node":{"type":"integer","title":"Result Node","description":"The ID of the node that is the result of the query.","isRequired":true,"uniqueKey":"plan.oneOf.0.result_node","typeLabel":"integer"},"llm_prompt":{"oneOf":[{"title":"Llm Prompt","description":"The LLM prompt that was used to generate this query plan.","uniqueKey":"plan.oneOf.0.llm_prompt.oneOf.0","typeLabel":"any"},{"type":"null","title":"Llm Prompt","description":"The LLM prompt that was used to generate this query plan.","uniqueKey":"plan.oneOf.0.llm_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.llm_prompt","typeLabel":"any | null"},"llm_plan":{"oneOf":[{"type":"string","title":"Llm Plan","description":"The result generated by the LLM.","uniqueKey":"plan.oneOf.0.llm_plan.oneOf.0","typeLabel":"string"},{"type":"null","title":"Llm Plan","description":"The result generated by the LLM.","uniqueKey":"plan.oneOf.0.llm_plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.llm_plan","typeLabel":"string | null"}},"uniqueKey":"plan.oneOf.0","typeLabel":"LogicalPlan · object"},{"type":"null","description":"The logical query plan to run. If specified, `query` must not be set.","uniqueKey":"plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan","typeLabel":"LogicalPlan · object | null"},"stream":{"type":"boolean","title":"Stream","description":"If true, query results will be streamed back to the client as they are generated. Applies only when calling the query api.","default":false,"uniqueKey":"stream","typeLabel":"boolean"},"summarize_result":{"type":"boolean","title":"Summarize Result","description":"If true, an english summary of the result in context of the original query will be returned.\nApplies only when calling the query API and only available when `stream=True`","default":false,"uniqueKey":"summarize_result","typeLabel":"boolean"},"rag_mode":{"type":"boolean","title":"Rag Mode","description":"If true, the query will only run a RAG query plan.","default":false,"uniqueKey":"rag_mode","typeLabel":"boolean"}},"type":"object","title":"Query","description":"A query against a DocSet. Contains either a natural language string or a query plan.","uniqueKey":"","typeLabel":"Query · object"},"examples":{"Example":{"title":"Example","value":{"docset_id":"\u003cstring>","query":"\u003cstring>","plan":{"query":"\u003cstring>","nodes":{},"result_node":123,"llm_prompt":"\u003cunknown>","llm_plan":"\u003cstring>"},"stream":false,"summarize_result":false,"rag_mode":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"1d1540e6-ba54-40be-90f5-d16c940de85f":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query","description":"The query that the plan is for.","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"nodes":{"additionalProperties":{"properties":{"node_id":{"type":"integer","title":"Node Id","description":"A unique integer ID representing this node.","isRequired":true,"uniqueKey":"nodes.additionalProperties.node_id","typeLabel":"integer"},"node_type":{"oneOf":[{"type":"string","title":"Node Type","description":"The type of this node.","uniqueKey":"nodes.additionalProperties.node_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Node Type","description":"The type of this node.","uniqueKey":"nodes.additionalProperties.node_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"nodes.additionalProperties.node_type","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"A detailed description of why this operator was chosen for this query plan.","uniqueKey":"nodes.additionalProperties.description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"A detailed description of why this operator was chosen for this query plan.","uniqueKey":"nodes.additionalProperties.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"nodes.additionalProperties.description","typeLabel":"string | null"},"inputs":{"items":{"type":"integer","uniqueKey":"nodes.additionalProperties.inputs.items.[INDEX]","typeLabel":"integer"},"type":"array","title":"Inputs","description":"A list of node IDs that this operation depends on.","default":[],"uniqueKey":"nodes.additionalProperties.inputs","typeLabel":"integer[]"}},"additionalProperties":true,"type":"object","required":["node_id"],"title":"Node","description":"A single operation in a logical plan.","uniqueKey":"nodes.additionalProperties","typeLabel":"Node · object"},"type":"object","title":"Nodes","description":"A mapping of node IDs to nodes in the query plan.","isRequired":true,"uniqueKey":"nodes","typeLabel":"Nodes · object"},"result_node":{"type":"integer","title":"Result Node","description":"The ID of the node that is the result of the query.","isRequired":true,"uniqueKey":"result_node","typeLabel":"integer"},"llm_prompt":{"oneOf":[{"title":"Llm Prompt","description":"The LLM prompt that was used to generate this query plan.","uniqueKey":"llm_prompt.oneOf.0","typeLabel":"any"},{"type":"null","title":"Llm Prompt","description":"The LLM prompt that was used to generate this query plan.","uniqueKey":"llm_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"llm_prompt","typeLabel":"any | null"},"llm_plan":{"oneOf":[{"type":"string","title":"Llm Plan","description":"The result generated by the LLM.","uniqueKey":"llm_plan.oneOf.0","typeLabel":"string"},{"type":"null","title":"Llm Plan","description":"The result generated by the LLM.","uniqueKey":"llm_plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"llm_plan","typeLabel":"string | null"}},"type":"object","required":["query","nodes","result_node"],"title":"LogicalPlan","description":"A logical query plan used to evaluate a query.","uniqueKey":"","typeLabel":"LogicalPlan · object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","nodes":{},"result_node":123,"llm_prompt":"\u003cunknown>","llm_plan":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4ea35721-7072-4d0c-a0f8-870efde0b7b1":{"description":"Not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0103d5bc-06fa-4e78-a655-a51c6ac8fb40":{"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"}},"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>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"156e71e5-394f-411c-9ec5-5e5cbc05d068":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"8f578b92-3513-451f-b34a-fce1ad6f83c3":{"url":"https://api.aryn.cloud","description":"US Region"},"8f62d6ca-6607-41db-84eb-8ccfc3ac24ec":{"url":"https://api.aryn.ai","description":"US Region"},"bf169c67-b51a-48cb-b7ce-eb33167cd490":{"url":"https://api.us.aryn.cloud","description":"US Region"},"5f7a6f84-8d3c-4d22-b2cd-dab551ecd408":{"url":"https://api.us.aryn.ai","description":"US Region"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"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":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/endpoint/platform/openapi.json"},"subdomain":"aryn","siteName":"Aryn Documentation","title":"Generate Plan - Aryn Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-10T22:09:50.273Z","originalFileLocation":"api-reference/query/generate-plan.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=\"Generate a query plan for the given query, but do not run it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aryn Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Generate Plan - Aryn Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate a query plan for the given query, but do not run it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aryn Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.aryn.ai/api-reference/query/generate-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aryn.mintlify.app/_mintlify/api/og/v2?division=Query\u0026amp;title=Generate+Plan\u0026amp;description=Generate+a+query+plan+for+the+given+query%2C+but+do+not+run+it.\u0026amp;theme=be158e76b417b7e99b2d8f02\u0026amp;signature=a743da99e1239db173edf4045860d74c79dc868c2069a77213af4b498d86bc5c\">\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=\"Generate Plan - Aryn Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate a query plan for the given query, but do not run it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aryn.mintlify.app/_mintlify/api/og/v2?division=Query\u0026amp;title=Generate+Plan\u0026amp;description=Generate+a+query+plan+for+the+given+query%2C+but+do+not+run+it.\u0026amp;theme=be158e76b417b7e99b2d8f02\u0026amp;signature=a743da99e1239db173edf4045860d74c79dc868c2069a77213af4b498d86bc5c\">\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/aryn/w2LZ1a3vrOj9YzXF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aryn Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#417586\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.aryn.ai/api-reference/query/generate-plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/query/generate-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.aryn.ai/#organization\",\"name\":\"Aryn Documentation\",\"url\":\"https://docs.aryn.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/aryn/NmC_FCDeIgvkLjlo/logo/aryn_logo_full.png?fit=max\u0026auto=format\u0026n=NmC_FCDeIgvkLjlo\u0026q=85\u0026s=a98c5e045ec1cf0148d9df24e5e6b97a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.aryn.ai#website\",\"name\":\"Aryn Documentation\",\"url\":\"https://docs.aryn.ai\",\"publisher\":{\"@id\":\"https://docs.aryn.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.aryn.ai/api-reference/query/generate-plan#webpage\",\"url\":\"https://docs.aryn.ai/api-reference/query/generate-plan\",\"name\":\"Generate Plan\",\"description\":\"Generate a query plan for the given query, but do not run it.\",\"dateModified\":\"2025-12-10T22:09:50.273Z\",\"isPartOf\":{\"@id\":\"https://docs.aryn.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.aryn.ai/api-reference/query/generate-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.aryn.ai/api-reference/query/generate-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Aryn Platform\",\"item\":\"https://docs.aryn.ai/api-reference/document/list-docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Generate Plan\",\"item\":\"https://docs.aryn.ai/api-reference/query/generate-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.aryn.ai/api-reference/query/generate-plan#apireference\",\"headline\":\"Generate Plan\",\"name\":\"Generate Plan\",\"description\":\"Generate a query plan for the given query, but do not run it.\",\"url\":\"https://docs.aryn.ai/api-reference/query/generate-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.aryn.ai/api-reference/query/generate-plan#webpage\"},\"dateModified\":\"2025-12-10T22:09:50.273Z\",\"publisher\":{\"@id\":\"https://docs.aryn.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.aryn.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aryn Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aryn Documentation","nav":{"global":{"anchors":[{"anchor":"Aryn Blog","icon":"newspaper","href":"https://www.aryn.ai/blog"},{"anchor":"Slack Community","icon":"slack","href":"https://join.slack.com/t/aryn-community/shared_invite/zt-36vhennsx-mN3UsqD6PT2vxVZxpqdHsw"},{"anchor":"Sycamore - Document ETL","icon":"bars-staggered","href":"https://github.com/aryn-ai/sycamore"}]},"tabs":[{"tab":"DocParse","pages":[{"title":"DocParse","href":"/docparse/introduction"}]},{"tab":"Deep Analytics (Preview)","pages":[{"title":"Deep Analytics (Preview)","href":"/introduction"}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/partition"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"DocParse","pages":[{"group":"Partition","pages":[{"title":"Partition Document","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json post /v1/document/partition","href":"/api-reference/partition/partition-document"},{"title":"Submit Document for Async Partitioning","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json post /v1/async/submit/document/partition","href":"/api-reference/partition/submit-document-for-async-partitioning"},{"title":"Get Async Task Status","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json get /v1/async/result/{task_id}","href":"/api-reference/partition/get-async-task-status"},{"title":"Cancel Async Task","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json post /v1/async/cancel/{task_id}","href":"/api-reference/partition/cancel-async-task"},{"title":"List Async Tasks","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json get /v1/async/list","href":"/api-reference/partition/list-async-tasks"}]}]},{"group":"Aryn Platform","pages":[{"group":"Document","pages":[{"title":"List Docs","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}/docs","href":"/api-reference/document/list-docs"},{"title":"Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets/{docset_id}/docs","href":"/api-reference/document/add-doc"},{"title":"Submit Document for Async Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/async/submit/storage/docsets/{docset_id}/docs","href":"/api-reference/document/submit-document-for-async-add-doc"},{"title":"Get Async Task Status","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/async/result/{task_id}","href":"/api-reference/document/get-async-task-status"},{"title":"Cancel Async Task for Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/async/cancel/{task_id}","href":"/api-reference/document/cancel-async-task-for-add-doc"},{"title":"List Async Tasks for Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/async/list","href":"/api-reference/document/list-async-tasks-for-add-doc"},{"title":"Get Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}/docs/{doc_id}","href":"/api-reference/document/get-doc"},{"title":"Delete Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json delete /v1/storage/docsets/{docset_id}/docs/{doc_id}","href":"/api-reference/document/delete-doc"},{"title":"Update Doc Properties","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json patch /v1/storage/docsets/{docset_id}/docs/{doc_id}/properties","href":"/api-reference/document/update-doc-properties"},{"title":"Get Doc Binary","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}/docs/{doc_id}/binary","href":"/api-reference/document/get-doc-binary"}]},{"group":"DocSet","pages":[{"title":"List Docsets","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets","href":"/api-reference/docset/list-docsets"},{"title":"Create Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets","href":"/api-reference/docset/create-docset"},{"title":"Get Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}","href":"/api-reference/docset/get-docset"},{"title":"Delete Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json delete /v1/storage/docsets/{docset_id}","href":"/api-reference/docset/delete-docset"},{"title":"Update Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json patch /v1/storage/docsets/{docset_id}","href":"/api-reference/docset/update-docset"},{"title":"Clone Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets/{docset_id}/clone","href":"/api-reference/docset/clone-docset"},{"title":"Set Readonly Docset","description":"Sets the read-only status of the DocSet.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets/{docset_id}/readonly/{value}","href":"/api-reference/docset/set-readonly-docset"}]},{"group":"Query","pages":[{"title":"Generate Plan","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query/plan","href":"/api-reference/query/generate-plan"},{"title":"Edit Plan","description":"Take an existing plan and user feedback to rewrite it.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json patch /v1/query/plan","href":"/api-reference/query/edit-plan"},{"title":"Run Query","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query","href":"/api-reference/query/run-query"},{"title":"Search","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query/search/{docset_id}","href":"/api-reference/query/search"}]},{"group":"Transform","pages":[{"title":"Extract Properties","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/jobs/extract-properties","href":"/api-reference/transform/extract-properties"},{"title":"Delete Properties","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/jobs/delete-properties","href":"/api-reference/transform/delete-properties"}]}]}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/example-code/introduction"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release_notes"}]},{"tab":"Model Context Protocol (MCP) Server","pages":[{"title":"Model Context Protocol (MCP) Server","href":"/mcp-server/aryn_mcp"}]}]},"title":"Generate Plan - Aryn Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}