{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Perplexity","description":"Perplexity API docs. Search: ranked web results with extracted page text for your own model. Agent: hosted models with web search and tools, returning a cited answer. Decisions: calibrated probabilities. Orchestrator (private preview): OpenAI- and Anthropic-format routing. Embeddings: vectors.","colors":{"primary":"#121516","light":"#F7F7F8","dark":"#121516"},"logo":{"light":"https://mintcdn.com/perplexity/gHf_T6roVjp3yaJv/logo/Perplexity_API_Platform.svg?fit=max\u0026auto=format\u0026n=gHf_T6roVjp3yaJv\u0026q=85\u0026s=07cab879ca2ce031bbc3da8b20f7ab90","dark":"https://mintcdn.com/perplexity/gHf_T6roVjp3yaJv/logo/Perplexity_API_Platform_Light.svg?fit=max\u0026auto=format\u0026n=gHf_T6roVjp3yaJv\u0026q=85\u0026s=416d5342d11094201b851dcf3eabdc9d","href":"/docs/getting-started/overview"},"favicon":"https://mintcdn.com/perplexity/1nonjPul2rlRMt-c/favicon.png?fit=max\u0026auto=format\u0026n=1nonjPul2rlRMt-c\u0026q=85\u0026s=f095c28dbad15e333c62683681f3ec20","api":{"examples":{"defaults":"required"}},"background":{"color":{"light":"#F7F7F8","dark":"#121516"}},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://console.perplexity.ai"}},"footer":{"socials":{"x":"https://x.com/perplexitydevs","discord":"https://discord.com/invite/perplexity-ai","website":"https://community.perplexity.ai"}},"search":{"prompt":"Search"},"seo":{"metatags":{"google-site-verification":"l-0uTKc1Uf60LaNt0Pkw1wLOBFEKoBIhUrv0EMr1J4U"},"indexing":"navigable"},"fonts":{"family":"GT Standard","weight":300,"source":"fonts/GT-Standard-S-Standard-Light.woff2","format":"woff2"},"icons":{"library":"tabler"},"banner":{"content":"For AI agents: see the complete [llms.txt](/llms.txt) documentation index.","dismissible":true},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. Try the [documentation home](/docs/getting-started/overview) or search above."}},"contextual":{"options":["copy","view","perplexity"],"display":"header"},"interaction":{"drilldown":false},"metadata":{"timestamp":false},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":{"style":"regular","name":"message-circle"},"href":"https://community.perplexity.ai"},{"anchor":"Blog","icon":{"style":"regular","name":"pencil"},"href":"https://research.perplexity.ai/articles"},{"anchor":"Changelog","icon":{"style":"regular","name":"clock"},"href":"/docs/resources/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"perplexity","hasAudioNarration":false,"actualSubdomain":"perplexity","customDomains":["docs.perplexity.ai"],"gitSource":{"type":"github","owner":"ppl-ai","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4c0c0be28fc317326e3e2","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Docs","count":102},{"language":"default","tag":"Cookbook","count":92},{"language":"default","tag":"Agent API","count":55},{"language":"default","tag":"API Reference","count":36},{"language":"default","tag":"Examples","count":30},{"language":"default","tag":"Resources","count":28},{"language":"default","tag":"Integrations","count":21},{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Search API","count":13},{"language":"default","tag":"Tools","count":10}]},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6983db9dfb7ad2556f59e58e","deploymentId":"65a9ccde8bfbe120a55f6d5b","questionText":"What is the Agent API?","status":"active","generatedBy":"manual","createdAt":"2026-02-04T23:51:57.148Z","updatedAt":"2026-02-13T03:11:32.396Z","__v":0},{"_id":"6983db84fb7ad2556f59e4ee","deploymentId":"65a9ccde8bfbe120a55f6d5b","questionText":"Which Agent API model should I use?","status":"active","generatedBy":"manual","createdAt":"2026-02-04T23:51:32.666Z","updatedAt":"2026-02-13T03:11:40.522Z","__v":0},{"_id":"6983db82fb7ad2556f59e4e1","deploymentId":"65a9ccde8bfbe120a55f6d5b","questionText":"How do I create an API key?","status":"active","generatedBy":"manual","createdAt":"2026-02-04T23:51:30.248Z","updatedAt":"2026-02-06T16:17:57.191Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","href":"/_mintlify/custom/perplexity/e6b9aa2e05455db2/styles.css"}],"page":{"pagePath":"api-reference/batches-get","slug":"/api-reference/batches-get","pageMetadata":{"openapi":"get /v1/batches/{batch_id}","title":"Retrieve a batch","description":null,"href":"/api-reference/batches-get"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/batches/{batch_id}","title":"Retrieve a batch","description":null,"href":"/api-reference/batches-get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/perplexity/a3bce64cf9d1b46a/section-menu.js","/_mintlify/custom/perplexity/594e3514bce8f9d1/navbar-cta.js","/_mintlify/custom/perplexity/72c576fa3737c96e/singular-tracking.js"],"openApiReferenceData":{"operation":{"operationId":"getBatch","summary":"Retrieve a batch","parameters":["07d3d088-e7b8-4c97-950b-fc144bdca51b"],"responses":{"200":"fed80901-db72-4dac-b6c6-a965e8511171","404":"c68511fb-0c13-4df2-8e62-aeb56fb5274f","429":"a2547f97-4431-4df4-a0ca-55441623b96d"},"security":["7029663f-a595-4619-8bd0-10a20e9d2b15"],"tags":["Batches"],"method":"get","type":"path","servers":["85f8ca23-4662-4c9b-bc51-58b9014a1eaa"],"path":"/v1/batches/{batch_id}","baseUrlOptions":["https://api.perplexity.ai"],"title":"Retrieve a batch","description":"","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"07d3d088-e7b8-4c97-950b-fc144bdca51b":{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Batch identifier (batch_...)","uniqueKey":"","typeLabel":"string"},"description":"Batch identifier (batch_...)"}},"responses":{"fed80901-db72-4dac-b6c6-a965e8511171":{"description":"The batch","content":{"application/json":{"schema":{"type":"object","required":["id","object","endpoint","input_file_id","completion_window","status","created_at","request_counts","usage"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["batch"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"endpoint":{"type":"string","isRequired":true,"uniqueKey":"endpoint","typeLabel":"string"},"input_file_id":{"type":"string","isRequired":true,"uniqueKey":"input_file_id","typeLabel":"string"},"completion_window":{"type":"string","isRequired":true,"uniqueKey":"completion_window","typeLabel":"string"},"status":{"type":"string","enum":["validating","in_progress","finalizing","completed","expired","cancelling","cancelled","failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"integer","format":"int64","description":"Unix seconds","isRequired":true,"uniqueKey":"created_at","typeLabel":"integer\u003cint64>"},"request_counts":{"type":"object","required":["total","completed","failed"],"properties":{"total":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"request_counts.total","typeLabel":"integer\u003cint64>"},"completed":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"request_counts.completed","typeLabel":"integer\u003cint64>"},"failed":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"request_counts.failed","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"request_counts","typeLabel":"object"},"usage":{"type":"object","required":["input_tokens","input_tokens_details","output_tokens","output_tokens_details","total_tokens"],"properties":{"input_tokens":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"usage.input_tokens","typeLabel":"integer\u003cint64>"},"input_tokens_details":{"type":"object","required":["cached_tokens"],"properties":{"cached_tokens":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"usage.input_tokens_details.cached_tokens","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"usage.input_tokens_details","typeLabel":"object"},"output_tokens":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"usage.output_tokens","typeLabel":"integer\u003cint64>"},"output_tokens_details":{"type":"object","required":["reasoning_tokens"],"properties":{"reasoning_tokens":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"usage.output_tokens_details.reasoning_tokens","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"usage.output_tokens_details","typeLabel":"object"},"total_tokens":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"usage.total_tokens","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"usage","typeLabel":"object"},"errors":{"oneOf":[{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","enum":["list"],"isRequired":true,"uniqueKey":"errors.oneOf.0.object","typeLabel":"enum\u003cstring>"},"data":{"type":"array","items":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.oneOf.0.data.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.oneOf.0.data.items.[INDEX].message","typeLabel":"string"},"line":{"oneOf":[{"type":"integer","format":"int64","description":"1-based input line the error refers to","uniqueKey":"errors.oneOf.0.data.items.[INDEX].line.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"1-based input line the error refers to","uniqueKey":"errors.oneOf.0.data.items.[INDEX].line.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.oneOf.0.data.items.[INDEX].line","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"errors.oneOf.0.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors.oneOf.0.data","typeLabel":"object[]"}},"uniqueKey":"errors.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object | null"},"output_file_id":{"oneOf":[{"type":"string","uniqueKey":"output_file_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"output_file_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"output_file_id","typeLabel":"string | null"},"error_file_id":{"oneOf":[{"type":"string","uniqueKey":"error_file_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error_file_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_file_id","typeLabel":"string | null"},"in_progress_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"in_progress_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"in_progress_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"in_progress_at","typeLabel":"integer\u003cint64> | null"},"expires_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"expires_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"integer\u003cint64> | null"},"finalizing_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"finalizing_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"finalizing_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"finalizing_at","typeLabel":"integer\u003cint64> | null"},"completed_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"completed_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"integer\u003cint64> | null"},"failed_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"failed_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"failed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"failed_at","typeLabel":"integer\u003cint64> | null"},"expired_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"expired_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"expired_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expired_at","typeLabel":"integer\u003cint64> | null"},"cancelling_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"cancelling_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"cancelling_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelling_at","typeLabel":"integer\u003cint64> | null"},"cancelled_at":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"cancelled_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"cancelled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelled_at","typeLabel":"integer\u003cint64> | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"batch","endpoint":"\u003cstring>","input_file_id":"\u003cstring>","completion_window":"\u003cstring>","status":"validating","created_at":123,"request_counts":{"total":123,"completed":123,"failed":123},"usage":{"input_tokens":123,"input_tokens_details":{"cached_tokens":123},"output_tokens":123,"output_tokens_details":{"reasoning_tokens":123},"total_tokens":123},"errors":{"object":"list","data":[{"code":"\u003cstring>","message":"\u003cstring>","line":123}]},"output_file_id":"\u003cstring>","error_file_id":"\u003cstring>","in_progress_at":123,"expires_at":123,"finalizing_at":123,"completed_at":123,"failed_at":123,"expired_at":123,"cancelling_at":123,"cancelled_at":123,"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"c68511fb-0c13-4df2-8e62-aeb56fb5274f":{"description":"Batch not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"message":{"description":"Human-readable error message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error type identifier","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":123,"param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a2547f97-4431-4df4-a0ca-55441623b96d":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"message":{"description":"Human-readable error message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error type identifier","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":123,"param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7029663f-a595-4619-8bd0-10a20e9d2b15":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"85f8ca23-4662-4c9b-bc51-58b9014a1eaa":{"url":"https://api.perplexity.ai","description":"Perplexity AI API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"},"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":"openapi.json"},"subdomain":"perplexity","siteName":"Perplexity","title":"Retrieve a batch - Perplexity","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T19:24:01.382Z","originalFileLocation":"api-reference/batches-get.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=\"application-name\" content=\"Perplexity\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_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/perplexity/rSPP83rcZL_iw-xo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a batch - Perplexity\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Perplexity\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.perplexity.ai/api-reference/batches-get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://perplexity.mintlify.site/_mintlify/api/og/v2?division=Batches\u0026amp;title=Retrieve+a+batch\u0026amp;theme=a240f15e82adca13791ab50d\u0026amp;signature=4ea6e715a9dd778c3c246d9ee31b6904fa66614295e0ee3226712b66ff74930d\">\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=\"Retrieve a batch - Perplexity\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://perplexity.mintlify.site/_mintlify/api/og/v2?division=Batches\u0026amp;title=Retrieve+a+batch\u0026amp;theme=a240f15e82adca13791ab50d\u0026amp;signature=4ea6e715a9dd778c3c246d9ee31b6904fa66614295e0ee3226712b66ff74930d\">\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/perplexity/rSPP83rcZL_iw-xo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Perplexity\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#121516\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"l-0uTKc1Uf60LaNt0Pkw1wLOBFEKoBIhUrv0EMr1J4U\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.perplexity.ai/api-reference/batches-get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/batches-get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.perplexity.ai/#organization\",\"name\":\"Perplexity\",\"url\":\"https://docs.perplexity.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/perplexity/gHf_T6roVjp3yaJv/logo/Perplexity_API_Platform.svg?fit=max\u0026auto=format\u0026n=gHf_T6roVjp3yaJv\u0026q=85\u0026s=07cab879ca2ce031bbc3da8b20f7ab90\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.perplexity.ai#website\",\"name\":\"Perplexity\",\"url\":\"https://docs.perplexity.ai\",\"publisher\":{\"@id\":\"https://docs.perplexity.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.perplexity.ai/api-reference/batches-get#webpage\",\"url\":\"https://docs.perplexity.ai/api-reference/batches-get\",\"name\":\"Retrieve a batch\",\"dateModified\":\"2026-11-11T19:24:01.382Z\",\"isPartOf\":{\"@id\":\"https://docs.perplexity.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.perplexity.ai/api-reference/batches-get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.perplexity.ai/api-reference/batches-get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agent API\",\"item\":\"https://docs.perplexity.ai/api-reference/agent-post\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Batches\",\"item\":\"https://docs.perplexity.ai/api-reference/files-create-post\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a batch\",\"item\":\"https://docs.perplexity.ai/api-reference/batches-get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.perplexity.ai/api-reference/batches-get#apireference\",\"headline\":\"Retrieve a batch\",\"name\":\"Retrieve a batch\",\"url\":\"https://docs.perplexity.ai/api-reference/batches-get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.perplexity.ai/api-reference/batches-get#webpage\"},\"dateModified\":\"2026-11-11T19:24:01.382Z\",\"publisher\":{\"@id\":\"https://docs.perplexity.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.perplexity.ai#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/batches-get.md","siteName":"Perplexity","nav":{"global":{"anchors":[{"anchor":"Community","icon":{"style":"regular","name":"message-circle"},"href":"https://community.perplexity.ai"},{"anchor":"Blog","icon":{"style":"regular","name":"pencil"},"href":"https://research.perplexity.ai/articles"},{"anchor":"Changelog","icon":{"style":"regular","name":"clock"},"href":"/docs/resources/changelog"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/docs/getting-started/overview"}]},{"tab":"Cookbook","groups":[{"group":"Cookbook","pages":[{"title":"Cookbook","sidebarTitle":"Perplexity API Cookbook","href":"/docs/cookbook"},{"title":"Getting Started","href":"/docs/cookbook/getting-started"},{"group":"Community Showcase","pages":[{"title":"Community Showcase","sidebarTitle":"Community Showcase","href":"/docs/cookbook/showcase/index"}]},{"group":"Examples","pages":[{"title":"Examples Overview","href":"/docs/cookbook/examples/README"},{"title":"Document Q\u0026A with Embeddings","href":"/docs/cookbook/examples/document-qa/README"},{"title":"Agent Research Assistant","href":"/docs/cookbook/examples/agent-research-assistant/README"},{"title":"Equity Research Brief","href":"/docs/cookbook/examples/equity-research-brief/README"},{"title":"TypeScript Agent CLI","href":"/docs/cookbook/examples/typescript-agent-cli/README"},{"title":"Image Analysis","href":"/docs/cookbook/examples/image-analysis/README"},{"title":"Multi-Provider Model Comparison","href":"/docs/cookbook/examples/model-comparison/README"},{"title":"Document Q\u0026A","href":"/docs/cookbook/examples/file-attachment-qa/README"},{"title":"Search News Monitor","href":"/docs/cookbook/examples/search-news-monitor/README"},{"title":"SEC Filing Search","href":"/docs/cookbook/examples/sec-filing-search/README"},{"title":"Competitor Buzz Tracker","href":"/docs/cookbook/examples/competitor-buzz-tracker/README"},{"title":"Talent Sourcer","href":"/docs/cookbook/examples/talent-sourcer/README"},{"title":"Enrich Customer Data with Agent API","href":"/docs/cookbook/examples/customer-enrichment-agent-api/README"},{"title":"Model Picker","href":"/docs/cookbook/examples/model-picker/README"},{"title":"Grounded Data Story with Kimi K3","href":"/docs/cookbook/examples/data-story-kimi-k3/README"},{"title":"Customizing Effort Levels","href":"/docs/cookbook/examples/agent-api-effort/README"},{"title":"GitHub investigation agent using managed connectors","href":"/docs/cookbook/examples/triage-bug-report-connectors/README"},{"title":"Triage Support Tickets with the Decisions API","href":"/docs/cookbook/examples/decisions-api-ticket-triage/README"},{"title":"Drive a Browser with the Decisions API","href":"/docs/cookbook/examples/decisions-api-browser-agent/README"},{"title":"Judge Citation Accuracy with Decisions API","href":"/docs/cookbook/examples/decisions-api-answer-gate/README"},{"title":"Check Agent Actions Before They Run with Decisions API","href":"/docs/cookbook/examples/decisions-api-action-gate/README"},{"title":"Rank Search Results to Answer Questions with the Best Quote Using Decisions API","href":"/docs/cookbook/examples/decisions-quote-finder/README"},{"title":"Catch Visual Bugs in CI with the Decisions API","href":"/docs/cookbook/examples/decisions-api-visual-qa-gate/README"},{"title":"Check a Chart for Misleading Design with a Decision Model","href":"/docs/cookbook/examples/decisions-api-chart-check/README"},{"title":"Enrich a CSV of Companies Overnight with the Batch API","href":"/docs/cookbook/examples/batch-api-company-enrichment/README"},{"title":"Track What the Web Said Each Week About a Topic, and Build a Report","href":"/docs/cookbook/examples/agent-api-story-timeline/README"},{"title":"Use Decisions API grounded web search to fact check claims","href":"/docs/cookbook/examples/decisions-api-web-grounding/README"},{"title":"Search Your Docs Folder with pplx-embed-v2, Dense and Contextual","href":"/docs/cookbook/examples/embeddings-docs-search/README"},{"title":"Build a Data Analytics Agent Using Custom Connectors","href":"/docs/cookbook/examples/agent-api-data-analyst/README"},{"title":"Turn Agent Failures into Regression Tests","href":"/docs/cookbook/examples/agent-api-regression-testing/README"}]},{"group":"Guides","pages":[{"title":"RAG with Perplexity Embeddings","href":"/docs/cookbook/articles/embeddings-rag/README"},{"title":"Streaming Citation Parsing","href":"/docs/cookbook/articles/streaming-citations/README"},{"title":"Structured Output Extraction","href":"/docs/cookbook/articles/structured-output-extraction/README"},{"title":"Multi-Provider Orchestration","href":"/docs/cookbook/articles/multi-provider-orchestration/README"},{"title":"Academic and Scholarly Search","href":"/docs/cookbook/articles/academic-search/README"},{"title":"Deep Research Workflows","href":"/docs/cookbook/articles/async-deep-research/README"},{"title":"Search Domain Filtering Patterns","href":"/docs/cookbook/articles/search-domain-filtering/README"},{"title":"VC Investment Memo Agent with LangGraph","href":"/docs/cookbook/articles/langchain-vc-memo-agent/README"},{"title":"Daily AI Stock News PDF with Skills","href":"/docs/cookbook/articles/agent-skills/README"},{"title":"Daily News Digest with LLM Deduplication","href":"/docs/cookbook/articles/news-dedupe-digest/README"},{"title":"Build an incident responder with Profiles, Skills, and Managed Connectors","sidebarTitle":"Incident responder","href":"/docs/cookbook/articles/incident-responder/README"},{"title":"Function Calling End-to-End","href":"/docs/cookbook/articles/function-calling-e2e/README"},{"title":"Search as Code for coding agents","sidebarTitle":"Search as Code for coding agents","href":"/docs/cookbook/articles/search-as-code-coding-agents/README"}]}]}]},{"tab":"API Reference","groups":[{"group":"Orchestrator API","pages":[{"openapi":"post /orchestrator/v1/chat/completions","title":"Create Chat Completion","href":"/api-reference/gateway-chat-completions-post"},{"openapi":"post /orchestrator/v1/responses","title":"Create Response","href":"/api-reference/gateway-responses-post"},{"openapi":"post /orchestrator/v1/messages","title":"Create Message","href":"/api-reference/gateway-messages-post"},{"openapi":"get /orchestrator/v1/models","title":"List Models","href":"/api-reference/gateway-models-get"},{"openapi":"get /orchestrator/v1/models/{model}","title":"Retrieve Model","href":"/api-reference/gateway-model-get"}]},{"group":"Agent API","boost":3,"pages":[{"openapi":"post /v1/agent","title":"Create Agent Response","href":"/api-reference/agent-post"},{"openapi":"get /v1/agent/{id}","title":"Retrieve Agent Response","href":"/api-reference/agent-get"},{"openapi":"get /v1/agent/{id}/files","title":"List Agent Response Files","href":"/api-reference/agent-files-get"},{"openapi":"get /v1/agent/{id}/files/{file_id}/content","title":"Download Agent Response File","href":"/api-reference/agent-file-content-get"},{"openapi":"post /v1/agent/{id}/cancel","title":"Cancel Agent Response","href":"/api-reference/agent-cancel-post"},{"openapi":"get /v1/models","title":"List Models","href":"/api-reference/models-get"},{"group":"Skills","pages":[{"openapi":"post /v1/skills","title":"Create a skill","href":"/api-reference/skills-create-post"},{"openapi":"get /v1/skills","title":"List skills","href":"/api-reference/skills-list-get"},{"openapi":"get /v1/skills/{skill_id}","title":"Get a skill","href":"/api-reference/skills-get"},{"openapi":"put /v1/skills/{skill_id}","title":"Add a skill revision","href":"/api-reference/skills-update-put"},{"openapi":"get /v1/skills/{skill_id}/revisions","title":"List skill revisions","href":"/api-reference/skills-revisions-get"},{"openapi":"get /v1/skills/{skill_id}/download","title":"Get a skill download URL","href":"/api-reference/skills-download-get"},{"openapi":"delete /v1/skills/{skill_id}","title":"Delete a skill","href":"/api-reference/skills-delete"}]},{"group":"Batches","pages":[{"openapi":"post /v1/files","title":"Upload a file","href":"/api-reference/files-create-post"},{"openapi":"get /v1/files","title":"List files","href":"/api-reference/files-list-get"},{"openapi":"get /v1/files/{file_id}","title":"Retrieve a file","href":"/api-reference/files-get"},{"openapi":"get /v1/files/{file_id}/content","title":"Download file content","href":"/api-reference/files-content-get"},{"openapi":"delete /v1/files/{file_id}","title":"Delete a file","href":"/api-reference/files-delete"},{"openapi":"post /v1/batches","title":"Create a batch","href":"/api-reference/batches-create-post"},{"openapi":"get /v1/batches","title":"List batches","description":"Lists your organization's batches, newest first.","href":"/api-reference/batches-list-get"},{"openapi":"get /v1/batches/{batch_id}","title":"Retrieve a batch","href":"/api-reference/batches-get"},{"openapi":"post /v1/batches/{batch_id}/cancel","title":"Cancel a batch","description":"Moves the batch to `cancelling`; it becomes `cancelled` once running\nitems stop. Completed items stay in the output file and are billed.\nCancelling a cancelled or cancelling batch returns it unchanged.\n","href":"/api-reference/batches-cancel-post"}]}]},{"group":"Search API","pages":[{"openapi":"post /search","title":"Search the Web","href":"/api-reference/search-post"}]},{"group":"Embeddings API","pages":[{"openapi":"post /v1/embeddings","title":"Create Embeddings","href":"/api-reference/embeddings-post"},{"openapi":"post /v1/contextualizedembeddings","title":"Create Contextualized Embeddings","href":"/api-reference/contextualized-embeddings-post"}]},{"group":"Decisions API","pages":[{"openapi":"post /v1/decisions","title":"Answer questions","href":"/api-reference/decisions-post"}]},{"group":"Authentication","pages":[{"openapi":"post /generate_auth_token","title":"Generate Auth Token","href":"/api-reference/generate-auth-token-post"},{"openapi":"post /revoke_auth_token","title":"Revoke Auth Token","href":"/api-reference/revoke-auth-token-post"}]},{"group":"Analytics API","pages":[{"openapi":"get /v1/analytics/computer/usage","title":"Usage Analytics","href":"/api-reference/computer-analytics-usage-get"},{"openapi":"get /v2/analytics/computer/usage","title":"Usage Analytics per Member","href":"/api-reference/computer-analytics-usage-v2-get"}]},{"group":"Audit API","pages":[{"openapi":"get /v1/admin/audit-events","title":"List audit events","href":"/api-reference/admin-audit-events-get"}]}]}]},"basePath":"","title":"Retrieve a batch - Perplexity","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DV3Oq1fY.js","dist-C-XZBk9h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D3Isdib3.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C4GwDT3_.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","AssistantPageLink--qIqmmVG.js"]}