Your API key, sent as Authorization: Bearer <key>.
Headers
Prefer
string
wait=<seconds> holds the request at most that long, up to 290. wait=0 answers with the task id at once.
Example:
"wait=120"
Accept
enum<string>
default:application/json
text/html answers with the task's saved page and needs payload.include.html: true. Any other value answers with JSON.
Available options:
application/json,
text/html
Body
application/json
Option 1
Option 2
Option 3
taskType
enum<string>
required
Public task types accepted by POST /v1/async/task and its batch endpoints. Dedicated analysis endpoints and AI Rendering publication create readable tasks through their own routes.
Available options:
CHATGPT,
PERPLEXITY,
GEMINI,
AIMODE,
GOOGLE_AIMODE,
GOOGLE,
GOOGLE_AIO,
GOOGLE_SERP,
GOOGLE_PLACES,
GOOGLE_NEWS,
NAVER_AI_BRIEF,
NAVER_AI_TAB,
NAVER_AI_MODE,
NAVER,
NAVER_SERP,
COMMERCE_SERP,
COMMERCE_PRODUCT,
BING_SEARCH,
BRAVE_SEARCH,
BING,
COPILOT,
BING_COPILOT,
MICROSOFT_COPILOT,
BING_AIMODE,
BING_COPILOT_SEARCH,
COPILOT_SEARCH,
META_AI,
QWEN,
DOUBAO,
BAIDU_WENXIN,
BAIDU_AI_SEARCH,
CITATION_ANALYSIS,
GEO_AUDIT,
SOURCE_INFLUENCE,
CITATION_ATTRIBUTION,
PROMPT_RESEARCH,
GEO_SCORE,
SEARCH,
WEB_SEARCH,
WEB_SCRAPE
Allowed value: "COMMERCE_SERP"
payload
object
required
The payload for the selected taskType; see TaskInput for the engine-specific schema.
Option 1
Option 2
Show child attributes
idempotencyKey
string
Optional. Deduplicates submissions for at least 30 days after the request. Omit for no deduplication. A duplicate is a 409 on this endpoint, but a success on the batch endpoint.
priority
integer
default:1
Compatibility field; does not guarantee execution order. Values outside 1–10 are clamped, not rejected.
Required range: 1 <= x <= 10
webhook
object
Optional. Omit to collect the result by polling instead.
Show child attributes
Response
The task ended: the body GET /v1/async/task/{id} returns, with response or error. With Accept: text/html, the saved page of the completed task.
success
boolean
required
task
object
required
Show child attributes
credits
object
required
Credits, with up to two decimals (for example 1.25). The submit response always shows 0: nothing is charged yet, and the task's price is held from your balance when it starts. Polling shows 0 until the task is terminal, then the settled charge: the task's price for COMPLETED, 0 for FAILED. A task webhook reports the same charge in creditsCharged; on a FAILED task it reports the task's price in creditsToCharge and 0 in creditsCharged. CITATION_ANALYSIS, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.
Show child attributes
response
object
The engine-specific result. Absent until the task is terminal. See the Engines guide for per-engine shapes. NAVER_AI_TAB preserves the original text, markdown, sources and cards when Naver returns HTTP success, a valid stream ending in done, and nonempty answer text with unknown_error. It includes upstreamError and returns immediately without retrying or rephrasing, even with retryQuery. COMPLETED means collection finished; the answer may still be incomplete. Empty, cut-off or malformed streams still fail. Policy refusals complete with a policy_declined notice. rawContent is returned only with include.rawResponse. With include.citationAnalysis, answer results also carry citationAnalysis (see Include). CITATION_ANALYSIS returns CitationAnalysisResult; see the Citation Analysis guide. PROMPT_RESEARCH returns PromptResearchResult; see the Prompt Research guide. GEO_SCORE returns GeoScoreResult; see the GEO Score guide. Answer engines with include.analysis add analysis (AnswerAnalysis).
Show child attributes
error
string
Present when task.status is FAILED. A plain string, not the {code, message, timestamp} object used by request-level errors.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"querying.ai","description":"One API for every AI answer engine. Submit a prompt, get the answer and its sources.","colors":{"primary":"#0F766E","light":"#2DD4BF","dark":"#0F766E"},"logo":{"light":"https://mintcdn.com/querying-ai/hbPR_IODrQaVec6W/logo/light.svg?fit=max\u0026auto=format\u0026n=hbPR_IODrQaVec6W\u0026q=85\u0026s=e70eb9454629ff45d5bf908843a393ac","dark":"https://mintcdn.com/querying-ai/hbPR_IODrQaVec6W/logo/dark.svg?fit=max\u0026auto=format\u0026n=hbPR_IODrQaVec6W\u0026q=85\u0026s=41b10775b1a6e4643f03ee42deae6528","href":"https://querying.ai"},"favicon":"https://mintcdn.com/querying-ai/7nShuIBsrfw0VD3y/favicon.svg?fit=max\u0026auto=format\u0026n=7nShuIBsrfw0VD3y\u0026q=85\u0026s=1a52a70c832728a9f4fb1fcf690fdf9d","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"}},"appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF","dark":"#141414"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://querying.ai/dashboard"}},"seo":{"metatags":{"msvalidate.01":"D437239914CD88705CAB1AC77E85675C","naver-site-verification":"ffb29a85960a4eb3c417886940616c926a99e23a"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":"css-variables"},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"toc"},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"ko","href":"ko/introduction"},{"language":"ja","href":"ja/introduction"},{"language":"zh","href":"zh/introduction"},{"language":"es","href":"es/introduction"},{"language":"fr","href":"fr/introduction"},{"language":"de","href":"de/introduction"},{"language":"pt","href":"pt/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"querying-ai","hasAudioNarration":false,"actualSubdomain":"querying-ai","customDomains":["docs.querying.ai"],"gitSource":{"type":"github","owner":"opactor-dev","repo":"querying.ai","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6adda8bb0fc6acf852ba3694"},"entitlements":{},"buildId":"6aff270ca7bd692b3fa066af","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"API reference","count":84},{"language":"de","tag":"API-Referenz","count":84},{"language":"es","tag":"Referencia de la API","count":84},{"language":"fr","tag":"Référence de l'API","count":84},{"language":"ja","tag":"APIリファレンス","count":84},{"language":"ko","tag":"API 레퍼런스","count":84},{"language":"pt","tag":"Referência da API","count":84},{"language":"zh","tag":"API 参考","count":84},{"language":"en","tag":"Guides","count":49},{"language":"de","tag":"Leitfäden","count":49},{"language":"es","tag":"Guías","count":49},{"language":"fr","tag":"Guides","count":49},{"language":"ja","tag":"ガイド","count":49},{"language":"ko","tag":"가이드","count":49},{"language":"pt","tag":"Guias","count":49},{"language":"zh","tag":"指南","count":49},{"language":"en","tag":"Monitors","count":22},{"language":"de","tag":"Monitore","count":22},{"language":"es","tag":"Monitores","count":22},{"language":"fr","tag":"Moniteurs","count":22},{"language":"ja","tag":"モニター","count":22},{"language":"ko","tag":"모니터","count":22},{"language":"pt","tag":"Monitores","count":22},{"language":"zh","tag":"监测","count":22},{"language":"en","tag":"AI Rendering","count":19},{"language":"de","tag":"AI Rendering","count":19},{"language":"es","tag":"AI Rendering","count":19},{"language":"fr","tag":"AI Rendering","count":19},{"language":"ja","tag":"AI Rendering","count":19},{"language":"ko","tag":"AI Rendering","count":19},{"language":"pt","tag":"AI Rendering","count":19},{"language":"zh","tag":"AI Rendering","count":19},{"language":"en","tag":"Answer engines","count":15},{"language":"de","tag":"Antwort-Engines","count":15},{"language":"es","tag":"Motores de respuesta","count":15},{"language":"fr","tag":"Moteurs de réponse","count":15},{"language":"ja","tag":"回答エンジン","count":15},{"language":"ko","tag":"답변 엔진","count":15},{"language":"pt","tag":"Mecanismos de resposta","count":15},{"language":"zh","tag":"回答引擎","count":15},{"language":"en","tag":"Operations","count":12},{"language":"de","tag":"Betrieb","count":12},{"language":"es","tag":"Operaciones","count":12},{"language":"fr","tag":"Exploitation","count":12},{"language":"ja","tag":"運用","count":12},{"language":"ko","tag":"운영","count":12},{"language":"pt","tag":"Operações","count":12},{"language":"zh","tag":"运维","count":12},{"language":"en","tag":"Sub-accounts","count":9},{"language":"de","tag":"Unterkonten","count":9},{"language":"es","tag":"Subcuentas","count":9},{"language":"fr","tag":"Sous-comptes","count":9},{"language":"ja","tag":"サブアカウント","count":9},{"language":"ko","tag":"하위 계정","count":9},{"language":"pt","tag":"Subcontas","count":9},{"language":"zh","tag":"子账户","count":9},{"language":"en","tag":"Exports","count":8},{"language":"en","tag":"Research","count":8},{"language":"en","tag":"SERP","count":8},{"language":"de","tag":"Exporte","count":8},{"language":"de","tag":"Recherche","count":8},{"language":"de","tag":"SERP","count":8},{"language":"es","tag":"Exportaciones","count":8},{"language":"es","tag":"Investigación","count":8},{"language":"es","tag":"SERP","count":8},{"language":"fr","tag":"Exports","count":8},{"language":"fr","tag":"Analyses","count":8},{"language":"fr","tag":"SERP","count":8},{"language":"ja","tag":"エクスポート","count":8},{"language":"ja","tag":"リサーチ","count":8},{"language":"ja","tag":"SERP","count":8},{"language":"ko","tag":"내보내기","count":8},{"language":"ko","tag":"리서치","count":8},{"language":"ko","tag":"SERP","count":8},{"language":"pt","tag":"Exportações","count":8},{"language":"pt","tag":"Pesquisa","count":8},{"language":"pt","tag":"SERP","count":8},{"language":"zh","tag":"导出","count":8},{"language":"zh","tag":"研究","count":8},{"language":"zh","tag":"SERP","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html:root{--q-sans:\n\t\t-apple-system, BlinkMacSystemFont, \"SF Pro Display\", \"SF Pro Text\", system-ui, \"Segoe UI\", Roboto,\n\t\t\"Apple SD Gothic Neo\", \"Noto Sans KR\", \"Noto Sans CJK KR\", \"Malgun Gothic\", sans-serif;--q-mono: ui-monospace, \"SF Mono\", SFMono-Regular, Menlo, Monaco, Consolas, monospace;--font-inter: var(--q-sans);--font-family-body-custom: var(--q-sans);--font-family-headings-custom: \"Pretendard Variable\", var(--q-sans);--font-paper-mono: var(--q-mono);--gray-50: 250 250 250;--gray-100: 245 245 245;--gray-200: 229 229 229;--gray-300: 212 212 212;--gray-400: 164 164 164;--gray-500: 133 133 133;--gray-600: 102 102 102;--gray-700: 68 68 68;--gray-800: 42 42 44;--gray-900: 22 22 22;--gray-950: 16 16 17;--sidebar-width: 16.5rem;--content-width: 44rem;--q-ink: #161616;--q-text: #161616b8;--q-muted: #161616a3;--q-line: #a4a4a433;--q-fill: #a4a4a40d;--q-fill-strong: #a4a4a41a;--q-card: #fff;--q-well: #fafafa;--q-code: #a4a4a41a;--q-accent: #0f766e;--q-accent-line: #0f766e66;--q-warning: #916200;--q-warning-fill: #da950014;--q-warning-line: #da95003d;--q-negative: #c5293d;--q-negative-fill: #f04c5a14;--q-negative-line: #f04c5a29;--mint-background: var(--q-well);--mint-foreground: #55555c;--mint-token-keyword: #0f766e;--mint-token-string-expression: #161616;--mint-token-string: #6d28d9;--mint-token-function: #6d28d9;--mint-token-constant: #1d4ed8;--mint-token-parameter: #55555c;--mint-token-punctuation: #16161673;--mint-token-comment: #16161680;--mint-token-link: #161616}html.dark{--q-ink: #f2f2f2;--q-text: #9c9c9c;--q-muted: #858585;--q-line: rgb(255 255 255 / 0.08);--q-fill: #fafafa0a;--q-fill-strong: #a4a4a41a;--q-card: #1b1b1d;--q-well: #101011;--q-code: #1b1b1d;--q-accent: #2dd4bf;--q-accent-line: #2dd4bf66;--q-warning: #e9b858;--q-warning-fill: #d2910014;--q-warning-line: #d291003d;--q-negative: #ff7184;--q-negative-fill: #ff435c14;--q-negative-line: #ff435c29;--mint-foreground: #b9b9bf;--mint-token-keyword: #7ee0d3;--mint-token-string-expression: #e7e7e7;--mint-token-string: #c4b5fd;--mint-token-function: #c4b5fd;--mint-token-constant: #93c5fd;--mint-token-parameter: #b9b9bf;--mint-token-punctuation: rgb(242 242 242 / 0.42);--mint-token-comment: rgb(242 242 242 / 0.38);--mint-token-link: #e7e7e7}img.nav-logo{height:20px!important}#navbar{border-bottom:1px solid var(--q-line)}#topbar-cta-button a{height:32px;padding:0 12px;border-radius:8px;background:var(--q-ink)}#topbar-cta-button a,#topbar-cta-button a *{color:rgb(var(--background-light))}.dark #topbar-cta-button a,.dark #topbar-cta-button a *{color:rgb(var(--background-dark))}#sidebar-content{border-right:1px solid var(--q-line)}.sidebar-group-header{color:var(--q-ink);font-size:14px;font-weight:500;letter-spacing:0;text-transform:none}#sidebar-content li>a{border-radius:8px;color:var(--q-text);font-size:14px}#sidebar-content li>a:hover{background:var(--q-fill);color:var(--q-ink)}#sidebar-content li[data-active]>a{background:var(--q-fill-strong);color:var(--q-ink);text-shadow:none}#table-of-contents nav>h2{font-family:inherit}#table-of-contents nav>h2 button{color:var(--q-muted);font-size:13px}#table-of-contents-content{border-left:1px solid var(--q-line)}#table-of-contents div:has(>#table-of-contents-content)>span{left:-0.5px;width:2px;height:20px;border-radius:2px;background:var(--q-ink)}.toc-item>a{color:var(--q-muted)}.toc-item>a:hover,.toc-item[data-active]>a{color:var(--q-ink)}#page-title{color:var(--q-ink);font-size:30px;font-weight:500;line-height:38px;letter-spacing:-0.025em;text-wrap:balance}@media (max-width: 640px){#page-title{font-size:26px;line-height:34px}}#header p{color:var(--q-text);font-size:17px;line-height:27px;text-wrap:balance}.prose{--tw-prose-body: var(--q-text);--tw-prose-headings: var(--q-ink);--tw-prose-lead: var(--q-text);--tw-prose-links: var(--q-accent);--tw-prose-bold: var(--q-ink);--tw-prose-counters: var(--q-muted);--tw-prose-bullets: var(--q-muted);--tw-prose-hr: var(--q-line);--tw-prose-quotes: var(--q-ink);--tw-prose-quote-borders: var(--q-line);--tw-prose-captions: var(--q-muted);--tw-prose-code: var(--q-ink);--tw-prose-th-borders: var(--q-line);--tw-prose-td-borders: var(--q-line)}#content{font-size:16px;line-height:26px}#content :is(p,li){text-wrap:pretty}#content .prose{font-size:inherit;line-height:inherit}#content :is(h2,h3,h4):not([data-component-part]){color:var(--q-ink);font-weight:500;text-wrap:balance}#content h2:not([data-component-part]){margin-top:48px;margin-bottom:12px;font-size:24px;line-height:32px;letter-spacing:-0.02em}#content h3:not([data-component-part]){margin-top:32px;margin-bottom:8px;font-size:18px;line-height:26px;letter-spacing:-0.01em}#content h4:not([data-component-part]){font-size:16px;line-height:24px}#content a.link{border-bottom:0;color:var(--q-accent);font-weight:inherit;text-decoration:underline;text-decoration-color:var(--q-accent-line);text-decoration-thickness:1px;text-underline-offset:3px}#content a.link:hover{text-decoration-color:currentColor}#content :not(pre)>code{padding:1px 6px;border:1px solid var(--q-line);border-radius:6px;background:var(--q-code);color:var(--q-ink);font-size:0.86em;font-weight:400}#content a :not(pre)>code,#content :is(h2,h3,h4) code{color:inherit}#content table{border:1px solid var(--q-line);border-collapse:separate;border-spacing:0;border-radius:10px;font-size:14px;line-height:1.5}#content table :is(th,td){min-width:0}#content table code{word-break:normal;overflow-wrap:break-word}#content table td:first-child code{white-space:nowrap}#content table:has(thead th:nth-child(7)){font-size:13px}#content table:has(thead th:nth-child(7)) :is(th,td){padding-inline:6px}#content thead,#content tbody tr{border-bottom:0}#content thead th{padding:8px 12px;border-bottom:1px solid var(--q-line);background:var(--q-fill);color:var(--q-ink);font-weight:500;vertical-align:bottom}#content thead th:first-child{border-top-left-radius:9px}#content thead th:last-child{border-top-right-radius:9px}#content thead:not(:has(th:not(:empty))){display:none}#content tbody td{padding:8px 12px;border-top:1px solid var(--q-line);vertical-align:top}#content tbody tr:first-child td{border-top:0}:lang(ko) body{word-break:keep-all;overflow-wrap:break-word}:lang(ko) #content{line-height:28px}:is(:lang(ko),:lang(ja),:lang(zh)) #page-title{font-size:28px;line-height:38px;letter-spacing:-0.02em}@media (max-width: 640px){:is(:lang(ko),:lang(ja),:lang(zh)) #page-title{font-size:24px;line-height:32px}}:is(:lang(ko),:lang(ja),:lang(zh)) #content h2:not([data-component-part]){font-size:22px;letter-spacing:-0.01em}:is(:lang(ko),:lang(ja),:lang(zh)) #content h3:not([data-component-part]){letter-spacing:-0.005em}.code-block{border-color:var(--q-line);border-radius:10px}.code-block-background{background:var(--q-well)}html.dark .code-block .code-block-background{background-color:var(--q-well)!important}.code-block pre{font-size:13px;line-height:21px}.code-block-fade-overlay{--fade-color-light: var(--q-well) !important;--fade-color-dark: var(--q-well) !important}.callout{gap:10px;padding:12px 16px;border:1px solid var(--q-line);border-radius:12px;background:var(--q-fill)}#content .callout [data-component-part=\"callout-content\"]{color:var(--q-text);font-size:14px;line-height:22px}.callout [data-component-part=\"callout-icon\"] svg{color:var(--q-muted)}.callout[data-callout-type=\"warning\"]{border-color:var(--q-warning-line);background:var(--q-warning-fill)}.callout[data-callout-type=\"warning\"] [data-component-part=\"callout-icon\"] svg{color:var(--q-warning)}.callout[data-callout-type=\"danger\"]{border-color:var(--q-negative-line);background:var(--q-negative-fill)}.callout[data-callout-type=\"danger\"] [data-component-part=\"callout-icon\"] svg{color:var(--q-negative)}[data-component-part=\"tabs-list\"]{gap:4px;margin-bottom:16px;padding-bottom:0;border-bottom:0}[data-component-part=\"tab-button\"]{margin-bottom:0;padding:4px 10px;border-bottom:0;border-radius:8px;color:var(--q-muted);font-weight:500}[data-component-part=\"tab-button\"]:hover,[data-component-part=\"tab-button\"][data-active=\"true\"]{color:var(--q-ink)}[data-component-part=\"tab-button\"][data-active=\"true\"]{background:var(--q-fill-strong)}.step [data-component-part=\"step-indicator\"]{background:var(--q-fill-strong);color:var(--q-ink);font-size:13px;font-weight:500}.step [data-component-part=\"step-line\"]{background:var(--q-line)}.step [data-component-part=\"step-title\"]{color:var(--q-ink);font-family:var(--font-family-headings-custom);font-size:16px;font-weight:600;letter-spacing:-0.01em}.card{border-color:var(--q-line);border-radius:12px;background:var(--q-card)}#content [data-component-part=\"card-title\"]{color:var(--q-ink);font-size:16px;font-weight:500;letter-spacing:-0.01em}#content [data-component-part=\"card-content\"]{color:var(--q-text);font-size:14px;line-height:22px}.accordion{border-color:var(--q-line);border-radius:12px;background:transparent}.tryit-button{border-radius:8px;background:var(--q-ink);color:rgb(var(--background-light))}.dark .tryit-button{color:rgb(var(--background-dark))}.tryit-button svg{background-color:currentColor}"}]}
{"page":{"pagePath":"api-reference/sync-task","slug":"/api-reference/sync-task","pageMetadata":{"title":"Run a task synchronously","description":"Submit a single task and get its result in the same request, within 290 seconds.","openapi":"POST /v1/sync/task","href":"/api-reference/sync-task"},"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: \"Submit a single task and get its result in the same request, within 290 seconds.\"\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":{"codeStyling":{"theme":"css-variables"},"config":{},"pageMetadata":{"title":"Run a task synchronously","description":"Submit a single task and get its result in the same request, within 290 seconds.","openapi":"POST /v1/sync/task","href":"/api-reference/sync-task"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/querying-ai/50db3c2a8c6df10f/pretendard.js","/_mintlify/custom/querying-ai/076e6719f53a8bea/sidebar-scroll.js"],"openApiReferenceData":{"operation":{"summary":"Run a task and wait for its result","description":"Submit a single task and get its result in the same request, within 290 seconds.","operationId":"runTaskSync","tags":["Tasks"],"parameters":["8ddba6fd-0d72-4819-bacf-d83df182a2d2","b3e40928-3c34-422f-935a-c23ef388569c"],"requestBody":"b2290c3d-8daf-4321-b054-aca4f70cadb2","responses":{"200":"5cb3fb2c-7d8e-4391-9a74-c31cf3537289","202":"09c0290f-312f-498b-926d-7a6de67a7ca8","400":"45dc1be3-7187-44ff-8ed4-39173986cf88","401":"cd5295da-c9d3-449c-b695-8fd962a318d6","402":"8c8349b8-bd29-4db8-a2f5-b2df25c06d97","403":"f00aa1df-232b-4ff7-bf09-27aec00cf05d","406":"731710dc-0324-4531-b425-5cbf4be4eb32","409":"24a3c847-c9ac-419c-b67d-9570389f7edb","413":"c03b7951-dccd-4496-b8b7-7f995a483c32","422":"6ff09fee-3a53-4afb-9cbe-8cf57b128c7e","429":"1c1f656a-5050-490d-a525-a2efa4c6e99d","503":"6b56b0c4-8245-44c3-aa25-c8ac53dcc2e1"},"method":"post","type":"path","servers":["03c555ab-4c28-4095-a5ca-17c281dd6cf9"],"security":["4887dbeb-be34-4005-a589-3b886b7d7629"],"path":"/v1/sync/task","baseUrlOptions":["https://api.querying.ai"],"title":"Run a task and wait for its result","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8ddba6fd-0d72-4819-bacf-d83df182a2d2":{"name":"Prefer","in":"header","required":false,"description":"`wait=\u003cseconds>` holds the request at most that long, up to 290. `wait=0` answers with the task id at once.","schema":{"type":"string","example":"wait=120","isRequired":false,"description":"`wait=\u003cseconds>` holds the request at most that long, up to 290. `wait=0` answers with the task id at once.","uniqueKey":"","typeLabel":"string"}},"b3e40928-3c34-422f-935a-c23ef388569c":{"name":"Accept","in":"header","required":false,"description":"`text/html` answers with the task's saved page and needs `payload.include.html: true`. Any other value answers with JSON.","schema":{"type":"string","enum":["application/json","text/html"],"default":"application/json","isRequired":false,"description":"`text/html` answers with the task's saved page and needs `payload.include.html: true`. Any other value answers with JSON.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["taskType","payload"],"properties":{"taskType":{"type":"string","description":"Public task types accepted by POST /v1/async/task and its batch endpoints. Dedicated analysis endpoints and AI Rendering publication create readable tasks through their own routes.","enum":["CHATGPT","PERPLEXITY","GEMINI","AIMODE","GOOGLE_AIMODE","GOOGLE","GOOGLE_AIO","GOOGLE_SERP","GOOGLE_PLACES","GOOGLE_NEWS","NAVER_AI_BRIEF","NAVER_AI_TAB","NAVER_AI_MODE","NAVER","NAVER_SERP","COMMERCE_SERP","COMMERCE_PRODUCT","BING_SEARCH","BRAVE_SEARCH","BING","COPILOT","BING_COPILOT","MICROSOFT_COPILOT","BING_AIMODE","BING_COPILOT_SEARCH","COPILOT_SEARCH","META_AI","QWEN","DOUBAO","BAIDU_WENXIN","BAIDU_AI_SEARCH","CITATION_ANALYSIS","GEO_AUDIT","SOURCE_INFLUENCE","CITATION_ATTRIBUTION","PROMPT_RESEARCH","GEO_SCORE","SEARCH","WEB_SEARCH","WEB_SCRAPE"],"const":"COMMERCE_SERP","isRequired":true,"uniqueKey":"oneOf.0.taskType","typeLabel":"enum\u003cstring>"},"payload":{"oneOf":[{"type":"object","description":"The payload for the selected taskType; see TaskInput for the engine-specific schema.","required":["site","query"],"properties":{"site":{"type":"string","enum":["amazon","walmart","target","ebay","aliexpress","google_shopping","sephora","ulta","coupang","oliveyoung","11st","lotteon","musinsa","kurly","rakuten","yahoo_shopping","qoo10","flipkart","myntra","nykaa","zalando"],"description":"The storefront to search. One site per task.","isRequired":true,"uniqueKey":"oneOf.0.payload.oneOf.0.site","typeLabel":"enum\u003cstring>"},"query":{"type":"string","minLength":1,"maxLength":500,"description":"The search. Send query or url, not both.","pattern":"\\S","isRequired":true,"uniqueKey":"oneOf.0.payload.oneOf.0.query","typeLabel":"string"},"limit":{"type":"integer","description":"Products to return. With query: 1-40, default 20. With url: 1-200, default 200.","maximum":40,"minimum":1,"uniqueKey":"oneOf.0.payload.oneOf.0.limit","typeLabel":"integer"},"url":{"type":"string","maxLength":2048,"description":"A listing page to read instead of searching: a Qoo10 shop page (https://www.qoo10.jp/shop/{shop}) with site qoo10. Returns every product the page shows, in page order, up to limit. Its query and fragment are dropped. Send query or url, not both.","minLength":1,"format":"uri","uniqueKey":"oneOf.0.payload.oneOf.0.url","typeLabel":"string\u003curi>"},"country":{"type":"string","description":"The site's own country: US for amazon, walmart, target, ebay, aliexpress, google_shopping, sephora and ulta; KR for coupang, oliveyoung, 11st, lotteon, musinsa and kurly; JP for rakuten, yahoo_shopping and qoo10; IN for flipkart, myntra and nykaa; DE for zalando. Omit to use it; any other value is rejected with 422 REGION_UNSUPPORTED.","uniqueKey":"oneOf.0.payload.oneOf.0.country","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.payload.oneOf.0","typeLabel":"object"},{"type":"object","description":"The payload for the selected taskType; see TaskInput for the engine-specific schema.","required":["site","url"],"properties":{"site":{"type":"string","enum":["amazon","walmart","target","ebay","aliexpress","google_shopping","sephora","ulta","coupang","oliveyoung","11st","lotteon","musinsa","kurly","rakuten","yahoo_shopping","qoo10","flipkart","myntra","nykaa","zalando"],"description":"The storefront to search. One site per task.","isRequired":true,"uniqueKey":"oneOf.0.payload.oneOf.1.site","typeLabel":"enum\u003cstring>"},"url":{"type":"string","maxLength":2048,"description":"A listing page to read instead of searching: a Qoo10 shop page (https://www.qoo10.jp/shop/{shop}) with site qoo10. Returns every product the page shows, in page order, up to limit. Its query and fragment are dropped. Send query or url, not both.","minLength":1,"format":"uri","isRequired":true,"uniqueKey":"oneOf.0.payload.oneOf.1.url","typeLabel":"string\u003curi>"},"query":{"type":"string","minLength":1,"maxLength":500,"description":"The search. Send query or url, not both.","pattern":"\\S","uniqueKey":"oneOf.0.payload.oneOf.1.query","typeLabel":"string"},"country":{"type":"string","description":"The site's own country: US for amazon, walmart, target, ebay, aliexpress, google_shopping, sephora and ulta; KR for coupang, oliveyoung, 11st, lotteon, musinsa and kurly; JP for rakuten, yahoo_shopping and qoo10; IN for flipkart, myntra and nykaa; DE for zalando. Omit to use it; any other value is rejected with 422 REGION_UNSUPPORTED.","uniqueKey":"oneOf.0.payload.oneOf.1.country","typeLabel":"string"},"limit":{"type":"integer","minimum":1,"maximum":200,"description":"Products to return. With query: 1-40, default 20. With url: 1-200, default 200.","uniqueKey":"oneOf.0.payload.oneOf.1.limit","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.payload.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.payload","typeLabel":"object"},"idempotencyKey":{"type":"string","description":"Optional. Deduplicates submissions for at least 30 days after the request. Omit for no deduplication. A duplicate is a `409` on this endpoint, but a success on the batch endpoint.","uniqueKey":"oneOf.0.idempotencyKey","typeLabel":"string"},"priority":{"type":"integer","description":"Compatibility field; does not guarantee execution order. Values outside 1–10 are clamped, not rejected.","minimum":1,"maximum":10,"default":1,"uniqueKey":"oneOf.0.priority","typeLabel":"integer"},"webhook":{"type":"object","description":"Optional. Omit to collect the result by polling instead.","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Receives a POST when the task reaches a terminal state.","isRequired":true,"uniqueKey":"oneOf.0.webhook.url","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.0.webhook","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["taskType","payload"],"properties":{"taskType":{"type":"string","description":"Public task types accepted by POST /v1/async/task and its batch endpoints. Dedicated analysis endpoints and AI Rendering publication create readable tasks through their own routes.","enum":["CHATGPT","PERPLEXITY","GEMINI","AIMODE","GOOGLE_AIMODE","GOOGLE","GOOGLE_AIO","GOOGLE_SERP","GOOGLE_PLACES","GOOGLE_NEWS","NAVER_AI_BRIEF","NAVER_AI_TAB","NAVER_AI_MODE","NAVER","NAVER_SERP","COMMERCE_SERP","COMMERCE_PRODUCT","BING_SEARCH","BRAVE_SEARCH","BING","COPILOT","BING_COPILOT","MICROSOFT_COPILOT","BING_AIMODE","BING_COPILOT_SEARCH","COPILOT_SEARCH","META_AI","QWEN","DOUBAO","BAIDU_WENXIN","BAIDU_AI_SEARCH","CITATION_ANALYSIS","GEO_AUDIT","SOURCE_INFLUENCE","CITATION_ATTRIBUTION","PROMPT_RESEARCH","GEO_SCORE","SEARCH","WEB_SEARCH","WEB_SCRAPE"],"const":"COMMERCE_PRODUCT","isRequired":true,"uniqueKey":"oneOf.1.taskType","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"The payload for the selected taskType; see TaskInput for the engine-specific schema.","required":["url"],"properties":{"url":{"type":"string","maxLength":2048,"description":"A product page on amazon.com, walmart.com, target.com, sephora.com or ulta.com (US); amazon.co.jp (JP, site amazon); 11st.co.kr, lotteon.com, musinsa.com, kurly.com or oliveyoung.co.kr (KR); item.rakuten.co.jp, store.shopping.yahoo.co.jp or qoo10.jp (JP); flipkart.com, myntra.com or nykaa.com (IN); or zalando.de (DE). The URL picks the storefront. Product URLs that COMMERCE_SERP returns for these storefronts work as they are, except yahoo_shopping's LOHACO pages on lohaco.yahoo.co.jp. A google_shopping product is read from the url COMMERCE_SERP returns for it (google.com/search?q={query}\u0026udm=28\u0026gl={market}#product={productId}\u0026title={title}), or from the productDetailUrl of a product in GOOGLE, GOOGLE_SERP or AIMODE results, which may add \u0026productDocid={productDocid} to the fragment: its gl is the market, the read runs the query in that market's Google Shopping again, or the title when Google no longer lists the product for the query, opens that product's panel, and fails with PAGE_UNAVAILABLE when Google lists it for neither.","minLength":1,"format":"uri","isRequired":true,"uniqueKey":"oneOf.1.payload.url","typeLabel":"string\u003curi>"},"country":{"type":"string","description":"The storefront's own country: US for amazon, walmart, target, sephora and ulta; KR for 11st, lotteon, musinsa, kurly and oliveyoung; JP for rakuten, yahoo_shopping and qoo10; IN for flipkart, myntra and nykaa; DE for zalando. A google_shopping url carries its own market in gl: US, GB, AU, CA, KR, JP, TW, HK, DE, FR, ES, IT, PL, PT, BR, IN, ID, TH or VN. Omit to use it; any other value is rejected with 422 REGION_UNSUPPORTED.","uniqueKey":"oneOf.1.payload.country","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.1.payload","typeLabel":"object"},"idempotencyKey":{"type":"string","description":"Optional. Deduplicates submissions for at least 30 days after the request. Omit for no deduplication. A duplicate is a `409` on this endpoint, but a success on the batch endpoint.","uniqueKey":"oneOf.1.idempotencyKey","typeLabel":"string"},"priority":{"type":"integer","description":"Compatibility field; does not guarantee execution order. Values outside 1–10 are clamped, not rejected.","minimum":1,"maximum":10,"default":1,"uniqueKey":"oneOf.1.priority","typeLabel":"integer"},"webhook":{"type":"object","description":"Optional. Omit to collect the result by polling instead.","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Receives a POST when the task reaches a terminal state.","isRequired":true,"uniqueKey":"oneOf.1.webhook.url","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.1.webhook","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["taskType","payload"],"properties":{"taskType":{"type":"string","description":"Public task types accepted by POST /v1/async/task and its batch endpoints. Dedicated analysis endpoints and AI Rendering publication create readable tasks through their own routes.","enum":["CHATGPT","PERPLEXITY","GEMINI","AIMODE","GOOGLE_AIMODE","GOOGLE","GOOGLE_AIO","GOOGLE_SERP","GOOGLE_PLACES","GOOGLE_NEWS","NAVER_AI_BRIEF","NAVER_AI_TAB","NAVER_AI_MODE","NAVER","NAVER_SERP","COMMERCE_SERP","COMMERCE_PRODUCT","BING_SEARCH","BRAVE_SEARCH","BING","COPILOT","BING_COPILOT","MICROSOFT_COPILOT","BING_AIMODE","BING_COPILOT_SEARCH","COPILOT_SEARCH","META_AI","QWEN","DOUBAO","BAIDU_WENXIN","BAIDU_AI_SEARCH","CITATION_ANALYSIS","GEO_AUDIT","SOURCE_INFLUENCE","CITATION_ATTRIBUTION","PROMPT_RESEARCH","GEO_SCORE","SEARCH","WEB_SEARCH","WEB_SCRAPE"],"isRequired":true,"uniqueKey":"oneOf.2.taskType","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"The payload for the selected taskType; see TaskInput for the engine-specific schema.","properties":{"prompt":{"type":"string","description":"The question, for LLM engines.","uniqueKey":"oneOf.2.payload.prompt","typeLabel":"string"},"query":{"type":"string","description":"The search term, for GOOGLE, AIMODE, GOOGLE_SERP, GOOGLE_PLACES, GOOGLE_NEWS, BING_SEARCH, COMMERCE_SERP and NAVER_* engines. BING_SEARCH reads `prompt` first and falls back to `query`, and rejects text over 4,000 characters with 422 VALIDATION_ERROR.","uniqueKey":"oneOf.2.payload.query","typeLabel":"string"},"retryQuery":{"type":"string","minLength":1,"maxLength":100000,"description":"NAVER_AI_TAB only. Optional alternative question to ask after Naver reports a generation error with no usable answer. The original question is asked first. An original answer preserved with response.upstreamError is returned immediately without retrying or rephrasing, even when retryQuery is provided. All attempts share the existing retry and time limits. If this question is used, response.recovery contains {reason: upstream_generation_error, query: \u003cthe alternative question>}; the answer belongs to that question. Without this field, retries keep the original question. Other failures and policy refusals do not activate the alternative. Other engines or a blank value are rejected with 400 VALIDATION_ERROR.","uniqueKey":"oneOf.2.payload.retryQuery","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code, case-insensitive. Omitted, empty or null means `US` (`KR` for NAVER_* engines). A value that is not an officially assigned code, such as `UK` (use `GB`), is rejected with 400 VALIDATION_ERROR, and a country this engine cannot serve is rejected at submit time with 422.","example":"US","uniqueKey":"oneOf.2.payload.country","typeLabel":"string"},"state":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"CHATGPT, BING_AIMODE, GEMINI, GOOGLE, AIMODE and GOOGLE_SERP. A US state as its two-letter code, case-insensitive; `GET /v1/states?country=US` lists them. CHATGPT and BING_AIMODE ask from a residential connection in the state, GEMINI asks as a device in its largest city, and the Google engines search with the state as Google's location, so local recommendations come from that state. Sent with `country` `US` or without `country`; another country, a code that is not a state, or `state` together with `uule` is rejected with 400 VALIDATION_ERROR, and other engines reject it with 422 LOCATION_UNSUPPORTED. Adds 1 credit to the task. The response echoes it as `state`.","example":"TX","uniqueKey":"oneOf.2.payload.state","typeLabel":"string"},"uule":{"type":"string","pattern":"^w\\+[A-Za-z0-9+/_-]{4,600}={0,2}$","description":"GOOGLE, AIMODE, GOOGLE_SERP and GOOGLE_PLACES. Google's own location parameter in its `w+` form, exactly as it goes into a Google search URL, for example `w+CAIQICIaQXVzdGluLFRleGFzLFVuaXRlZCBTdGF0ZXM` for Austin, Texas. It is sent to Google unchanged, so the results page, AI Overview and AI Mode answer for that place. Use it instead of `state` when your system already stores UULEs; sending both is rejected with 400 VALIDATION_ERROR, as is a value that is not a `w+` UULE (for example the percent-encoded `w%2B…`). Other engines reject it with 422 LOCATION_UNSUPPORTED. GOOGLE_PLACES takes no `state` and rejects `uule` together with `city` with 422 VALIDATION_ERROR. The response echoes it as `uule`.","example":"w+CAIQICIaQXVzdGluLFRleGFzLFVuaXRlZCBTdGF0ZXM","uniqueKey":"oneOf.2.payload.uule","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":100,"description":"GOOGLE_PLACES only. The place to search from, named the way Google names places: city, state or region, and country, for example `Reno, Nevada, United States`. Every Places page is searched from it. Send `city` or `uule`; `city` together with `uule` is rejected with 422 VALIDATION_ERROR. The response echoes it as `city`.","example":"Reno, Nevada, United States","uniqueKey":"oneOf.2.payload.city","typeLabel":"string"},"pages":{"type":"integer","minimum":1,"maximum":50,"default":1,"description":"GOOGLE_NEWS and GOOGLE_SERP. GOOGLE_NEWS: News pages to read, 1-10, 10 articles each. GOOGLE_SERP: results pages to read starting at `page`, 1-50, all on one session and one IP address; not with `include.rawResponse` (422 VALIDATION_ERROR). Reading stops at Google's last page. Priced per page read; the task holds credits for every page asked for when it starts and is charged for the pages it read.","example":2,"uniqueKey":"oneOf.2.payload.pages","typeLabel":"integer"},"device":{"type":"string","enum":["desktop","mobile","android","tablet"],"default":"desktop","description":"GOOGLE_SERP and GOOGLE_NEWS. The page Google serves: `desktop`, Chrome on Android as `mobile` or `android`, where `mobile` is an alias for `android`, or Chrome on an Android tablet as `tablet` (GOOGLE_SERP only). A mobile or tablet page returns the same fields in Google's layout for that device and costs the same credits. `ios` is rejected with 422 VALIDATION_ERROR, because the Google lane runs Chrome, not Safari.","example":"mobile","uniqueKey":"oneOf.2.payload.device","typeLabel":"enum\u003cstring>"},"hl":{"type":"string","maxLength":35,"description":"GOOGLE, AIMODE, GOOGLE_SERP and GOOGLE_NEWS. The interface language of the results page, as Google's own `hl` (`en`, `de`, `pt-BR`). It overrides the language derived from `country`, so the market and the interface language can differ. Case is normalized, `pt-br` reads as `pt-BR`. Values that are not a language code are rejected with 422 VALIDATION_ERROR.","example":"de","uniqueKey":"oneOf.2.payload.hl","typeLabel":"string"},"webSearch":{"type":"boolean","default":true,"description":"CHATGPT only. false asks with ChatGPT's search toggle off, so ChatGPT chooses on its own when to search. Applies to every answer of the task, followUps included. Rejected with 422 EVIDENCE_UNSUPPORTED together with include.html.","uniqueKey":"oneOf.2.payload.webSearch","typeLabel":"boolean"},"images":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"string","description":"A public http(s) URL, or a data URL: data:image/jpeg, png, webp or gif;base64,\u003cdata>.","uniqueKey":"oneOf.2.payload.images.items.[INDEX]","typeLabel":"string"},"description":"CHATGPT only. Photos asked with the first question, the way a user adds them with ChatGPT's photo button: JPEG, PNG, WebP or GIF, up to 10 MB each. A data URL counts toward the request body limit (1 MiB on POST /v1/async/task). followUps keep asking about the photos in the same conversation, at 1 credit per answer. Rejected with 400 VALIDATION_ERROR together with country CN or HK, or continueFrom, and with 422 EVIDENCE_UNSUPPORTED together with include.html. Other engines reject it with 400 VALIDATION_ERROR. A photo that cannot be fetched or read fails the task with BAD_PAYLOAD.","example":["https://www.example.com/photos/product.jpg"],"uniqueKey":"oneOf.2.payload.images","typeLabel":"string[]"},"followUps":{"type":"array","minItems":1,"maxItems":4,"description":"CHATGPT only. Questions asked after the first answer in the same conversation, in order. Each answer costs 1 credit. The result lists the answers in followUps and, when a select cannot be pressed, where and why the turns stopped in followUpsStopped.","items":{"oneOf":[{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","minLength":1,"maxLength":100000,"description":"A question of your own.","isRequired":true,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.0.prompt","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["select"],"properties":{"select":{"type":"object","additionalProperties":false,"description":"Press a follow-up form's button in the previous answer.","properties":{"button":{"type":"integer","minimum":0,"default":0,"description":"The button, counted from 0 across the answer's forms.","uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.button","typeLabel":"integer"},"choices":{"oneOf":[{"type":"object","description":"Options to pick by choice name, or as an array in the form's order. A pick is an option's value or label, or its position from 0. Unpicked choices keep ChatGPT's selection.","maxProperties":20,"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"minLength":1,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","minimum":0,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.0.additionalProperties.oneOf.1","typeLabel":"integer"}],"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.0.additionalProperties","typeLabel":"string | integer"},"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.0","typeLabel":"object"},{"type":"array","items":{"oneOf":[{"type":"string","maxLength":500,"minLength":1,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","minimum":0,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.1.items.[INDEX]","typeLabel":"string | integer"},"description":"Options to pick by choice name, or as an array in the form's order. A pick is an option's value or label, or its position from 0. Unpicked choices keep ChatGPT's selection.","maxItems":20,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices.oneOf.1","typeLabel":"(string | integer)[]"}],"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select.choices","typeLabel":"object | (string | integer)[]"}},"isRequired":true,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1.select","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.payload.followUps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.payload.followUps","typeLabel":"object[]"},"continueFrom":{"type":"string","format":"uuid","description":"CHATGPT only. The id of a completed CHATGPT task of this account: asks one more question in its conversation, under its last answer, with either `prompt` or `select`. `country` and `state` carry over; leave them out or send the same values. The result carries `conversation` (`id`, `turn`, `expiresAt`) and, when it pressed a form, `selection`. Rejected before any charge with 400 VALIDATION_ERROR (another account's or engine's task, a task not completed, an invalid select) or 400 CONVERSATION_EXPIRED (after `conversation.expiresAt`, 3 hours after the conversation's first answer).","uniqueKey":"oneOf.2.payload.continueFrom","typeLabel":"string\u003cuuid>"},"select":{"type":"object","additionalProperties":false,"description":"With `continueFrom`, instead of `prompt`: press a follow-up form's button in the last answer of the continued task. Answers that show a form list them in `forms` (`buttons` in `button` order, `choices` with their `name`, the option selected at first and the `options`).","properties":{"button":{"type":"integer","minimum":0,"default":0,"description":"The button, counted from 0 across the answer's forms.","uniqueKey":"oneOf.2.payload.select.button","typeLabel":"integer"},"choices":{"oneOf":[{"type":"object","description":"Options to pick by choice name, or as an array in the form's order. A pick is an option's value or label, or its position from 0. Unpicked choices keep ChatGPT's selection.","maxProperties":20,"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"minLength":1,"uniqueKey":"oneOf.2.payload.select.choices.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","minimum":0,"uniqueKey":"oneOf.2.payload.select.choices.oneOf.0.additionalProperties.oneOf.1","typeLabel":"integer"}],"uniqueKey":"oneOf.2.payload.select.choices.oneOf.0.additionalProperties","typeLabel":"string | integer"},"uniqueKey":"oneOf.2.payload.select.choices.oneOf.0","typeLabel":"object"},{"type":"array","items":{"oneOf":[{"type":"string","maxLength":500,"minLength":1,"uniqueKey":"oneOf.2.payload.select.choices.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","minimum":0,"uniqueKey":"oneOf.2.payload.select.choices.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"oneOf.2.payload.select.choices.oneOf.1.items.[INDEX]","typeLabel":"string | integer"},"description":"Options to pick by choice name, or as an array in the form's order. A pick is an option's value or label, or its position from 0. Unpicked choices keep ChatGPT's selection.","maxItems":20,"uniqueKey":"oneOf.2.payload.select.choices.oneOf.1","typeLabel":"(string | integer)[]"}],"uniqueKey":"oneOf.2.payload.select.choices","typeLabel":"object | (string | integer)[]"}},"uniqueKey":"oneOf.2.payload.select","typeLabel":"object"},"page":{"type":"integer","minimum":1,"maximum":10,"default":1,"description":"GOOGLE_SERP, NAVER_SERP and GOOGLE_PLACES. The results page to return, 1-10 (1-5 for GOOGLE_PLACES). Positions count across pages, so page 2 starts at 11 on Google, at 16 on Naver and at 21 on Google Places. GOOGLE_PLACES reads that one page alone and charges 1 credit; send `page` or `limit`, not both (422 VALIDATION_ERROR).","uniqueKey":"oneOf.2.payload.page","typeLabel":"integer"},"url":{"type":"string","format":"uri","description":"GOOGLE_SERP, GOOGLE_AIO and GOOGLE_AIMODE: an https://www.google.com/search address sent in place of `query`, or the same address on a Google country domain such as www.google.de, which is asked at www.google.com with the same path and parameters; without gl or `country`, the domain's country is the market. An address without gl is asked with the market's gl added. Its q, gl, hl and uule are read as `query`, `country`, `hl` and `uule`, and on GOOGLE_SERP its start as `page`; GOOGLE_AIMODE needs udm=50. All three ask Google with the address exactly as written, so its other parameters (num, lr, tbs, filter and so on) reach Google; Google lists ten results a page whatever num says. An address that picks another tab with udm or tbm on GOOGLE_SERP or GOOGLE_AIO, one without udm=50 on GOOGLE_AIMODE, or one sent together with `query`, `hl`, `uule` or `page`, returns 422 VALIDATION_ERROR. NAVER_SERP with `action` `page`: the naver.com page to read (blog, cafe, news, terms, kin or any other naver.com page). A redirect that leaves naver.com fails the task. COMMERCE_SERP: a listing page read instead of a query, a Qoo10 shop page (https://www.qoo10.jp/shop/{shop}) with site qoo10. WEB_SCRAPE: the public page or PDF to read.","uniqueKey":"oneOf.2.payload.url","typeLabel":"string\u003curi>"},"action":{"type":"string","enum":["page","search"],"description":"NAVER_SERP: `page` reads `url` instead of searching. Omit it to search.","uniqueKey":"oneOf.2.payload.action","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","minimum":1,"maximum":200,"description":"COMMERCE_SERP: product count, integer 1-40 (default 20) with query, 1-200 (default 200) with url. GOOGLE_PLACES: the places to return from the top of the list, 1-100 (default 20, one page); the task holds 1 credit per 20 places and is charged for the pages it read. Send `limit` or `page`, not both.","uniqueKey":"oneOf.2.payload.limit","typeLabel":"integer"},"maxChars":{"type":"integer","minimum":1000,"maximum":200000,"description":"NAVER_SERP with `action` `page`. The most characters of page text to return: NAVER_SERP 1,000-50,000 (default 20,000), WEB_SCRAPE 1,000-200,000 (default 100,000). `truncated` says whether it was cut.","uniqueKey":"oneOf.2.payload.maxChars","typeLabel":"integer"},"rawHtml":{"type":"boolean","description":"WEB_SCRAPE: also return the HTML that was read as rawHtml.","uniqueKey":"oneOf.2.payload.rawHtml","typeLabel":"boolean"},"contentHtml":{"type":"boolean","description":"WEB_SCRAPE: also return the main content as HTML in contentHtml.","uniqueKey":"oneOf.2.payload.contentHtml","typeLabel":"boolean"},"jsonLd":{"type":"boolean","description":"WEB_SCRAPE: also return the page's schema.org JSON-LD blocks as jsonLd.","uniqueKey":"oneOf.2.payload.jsonLd","typeLabel":"boolean"},"render":{"type":"boolean","description":"WEB_SCRAPE: read the page in a browser after its script ran, even when a plain request already gets it. GOOGLE_SERP with `include.html: true`: `html` is the results page as Chrome shows it once its scripts ran, with the AI Overview loaded and opened by its Show more, read through an exit in a country where Google shows AI Overviews; any `device` and `page`. Costs 1 credit on top of the search price, charged only when `html.status` is `ok`, and adds about 5 to 10 seconds. Without `include.html: true`, or as a value other than a boolean, it is rejected with 422 VALIDATION_ERROR.","uniqueKey":"oneOf.2.payload.render","typeLabel":"boolean"},"screenshot":{"type":"boolean","description":"WEB_SCRAPE: read the page in a laptop-sized browser, scrolled to the end with its images drawn, and also return screenshot (a stored JPEG of its first four screens) and shown (its text as a person reads it, where each image sits, and the page as drawn). Implies render.","uniqueKey":"oneOf.2.payload.screenshot","typeLabel":"boolean"},"maxAge":{"type":"integer","minimum":0,"maximum":604800000,"description":"WEB_SCRAPE: accept a cached read younger than this, in milliseconds, up to 604,800,000 (7 days). Omit or send 0 to always read fresh.","uniqueKey":"oneOf.2.payload.maxAge","typeLabel":"integer"},"include":{"type":"object","description":"Optional output flags. `markdown`, `rawResponse`, `searchQueries`, `ads` and `shopping` are ignored by engines that do not support them. `citationLinks` is PERPLEXITY only and requires `markdown: true`. `analysis` on an unsupported engine is rejected with 422 VALIDATION_ERROR, `html` with 422 EVIDENCE_UNSUPPORTED, and `screenshot: true` with 400 VALIDATION_ERROR on every engine. See the engine guide for the support table.","properties":{"markdown":{"type":"boolean","description":"Adds `markdown` on CHATGPT (on by default), PERPLEXITY, GEMINI, GOOGLE (the AI Overview), BING_SEARCH (the summary) and COPILOT. AIMODE, BING_AIMODE, META_AI, QWEN, DOUBAO, BAIDU_WENXIN, BAIDU_AI_SEARCH, NAVER_AI_BRIEF and NAVER_AI_TAB return `markdown` without the flag.","uniqueKey":"oneOf.2.payload.include.markdown","typeLabel":"boolean"},"citationLinks":{"type":"boolean","description":"PERPLEXITY only, with `markdown: true`. Turns bare `[N]` citation markers in `markdown` into `[N](url)` links to the matching `sources[].url`. `text`, existing links, code, escaped markers and markers without a matching source stay unchanged. Off by default; other requests are rejected with 422 VALIDATION_ERROR.","uniqueKey":"oneOf.2.payload.include.citationLinks","typeLabel":"boolean"},"html":{"type":"boolean","description":"Returns `html`: `{\"status\": \"ok\", \"url\", \"expiresAt\"}`, the screen the engine showed for the answer, which opens without an API key until `expiresAt` (30 days). On GOOGLE and AIMODE it is the results page Google served, scripts removed; on GOOGLE_SERP it is the document Google sent for the results page, before its scripts ran, with its scripts kept and session identifiers removed, or with `render: true` the page as Chrome shows it once its scripts ran, AI Overview opened (not with `pages` above 1, `state`, `uule`, `include.rawResponse` or `include.aiOverview`: 422 VALIDATION_ERROR); on BING_AIMODE it is the Bing AI Mode screen made from the pages Bing served, the question and the answer with its sponsored products, scripts removed and images included; on CHATGPT, GEMINI, PERPLEXITY and META_AI it is the engine's screen as it showed when the answer finished, scripts removed and images included. A screen that could not be collected, did not match the answer, or could not be stored comes back as `{\"status\": \"failed\", \"error\": \"EVIDENCE_FAILED\"}` and the task still completes. Other engines reject it with 422 EVIDENCE_UNSUPPORTED, COPILOT included since 2026-11-06 (its lane ended on Microsoft's sign-in: every 2026-11-05 ask failed with COPILOT_SIGN_IN_REQUIRED; pages issued earlier stay open until they expire), and so does CHATGPT with `state`, country `CN` or `HK`, `continueFrom`, `webSearch: false` or `images`: the page comes only with a new conversation asked with web search on, without a device location or photos. On CHATGPT, PERPLEXITY and META_AI it costs 0.25 credits per task on top of the engine's price, charged only when `html.status` is `ok`; on GEMINI, GOOGLE, AIMODE and BING_AIMODE it costs nothing more. Off by default.","uniqueKey":"oneOf.2.payload.include.html","typeLabel":"boolean"},"rawResponse":{"type":"boolean","description":"Returns the engine's raw payload. Arrives as `rawResponse` on CHATGPT, GEMINI, PERPLEXITY, COPILOT, BING_AIMODE, META_AI, QWEN, DOUBAO, BAIDU_WENXIN and BAIDU_AI_SEARCH, and as `rawContent` on GOOGLE, AIMODE, GOOGLE_SERP, BING_SEARCH, NAVER_AI_BRIEF and NAVER_AI_TAB. GOOGLE_PLACES and NAVER_SERP return no raw payload. Off by default.","uniqueKey":"oneOf.2.payload.include.rawResponse","typeLabel":"boolean"},"aiOverview":{"type":"boolean","description":"GOOGLE_SERP only. Adds the AI Overview Google shows for the search as `aiOverview`: `{\"text\", \"markdown\", \"sources\"}`, or `null` when Google shows none. First page, `desktop`, without `state`, `location` or `uule`; other requests are rejected with 422 VALIDATION_ERROR. Costs 1 credit on top of the search's price. Off by default.","uniqueKey":"oneOf.2.payload.include.aiOverview","typeLabel":"boolean"},"searchQueries":{"type":"boolean","description":"Gates `searchQueries` on CHATGPT (on by default) and PERPLEXITY. On CHATGPT it also gates `mapSearchQueries`. Other engines that emit it do so unconditionally.","uniqueKey":"oneOf.2.payload.include.searchQueries","typeLabel":"boolean"},"ads":{"type":"boolean","description":"Only honored by CHATGPT.","uniqueKey":"oneOf.2.payload.include.ads","typeLabel":"boolean"},"shopping":{"type":"boolean","description":"Only honored by CHATGPT.","uniqueKey":"oneOf.2.payload.include.shopping","typeLabel":"boolean"},"citationAnalysis":{"type":"boolean","description":"Answer engines (CHATGPT, GEMINI, PERPLEXITY, GOOGLE_AIO, GOOGLE_AIMODE, NAVER_AI_BRIEF, NAVER_AI_TAB, BING_SEARCH, COPILOT): run a Citation Analysis analysis on the answer as soon as it is collected. The result then carries `response.citationAnalysis`, the analysis task as GET /v1/async/task/{id} returns it (`task`, `credits`, `response` or `error`), or `{error}` when no analysis could start (no cited URL, or credits or the key's daily limit cannot cover its hold). The webhook is sent once, after the analysis settles; a polled answer task is COMPLETED first, so poll until `response.citationAnalysis.task.status` is terminal. The analysis is charged separately by usage; a key limited to certain task types must also allow CITATION_ANALYSIS. Any other engine is rejected with 400.","uniqueKey":"oneOf.2.payload.include.citationAnalysis","typeLabel":"boolean"},"geoAudit":{"type":"boolean","deprecated":true,"description":"Accepted alias of `citationAnalysis`; results still carry `response.citationAnalysis`.","uniqueKey":"oneOf.2.payload.include.geoAudit","typeLabel":"boolean"},"sourceInfluence":{"type":"boolean","deprecated":true,"description":"Accepted alias of `citationAnalysis`; results still carry `response.citationAnalysis`.","uniqueKey":"oneOf.2.payload.include.sourceInfluence","typeLabel":"boolean"},"analysis":{"type":"boolean","description":"CHATGPT, GEMINI, PERPLEXITY, GOOGLE, AIMODE, NAVER_AI_BRIEF and NAVER_AI_TAB. Adds `analysis` (AnswerAnalysis) to the response: every brand the answer names in order, with recommendation and sentiment, the presence of `brand` and `competitors`, and the kind of each cited site. 1 credit per task on top of the engine price, charged only when `analysis.status` is `ok`. Rejected with 422 on other engines.","uniqueKey":"oneOf.2.payload.include.analysis","typeLabel":"boolean"},"entityDetails":{"type":"boolean","description":"CHATGPT only. Adds `entityDetails`: for each card in the answer (up to 20), the detail panel ChatGPT opens when a reader clicks it, with `name`, `category`, `query`, `status` (`ok` or `failed` with `error`), `markdown`, `sources` (`position`, `url`, `label`, `site`, `description`), `products` (the shopping card a product's panel opens on, shaped like `shoppingCards[].products`), `images` and `complete` (`false` when ChatGPT stopped writing the panel early). `error` is `ENTITY_DETAIL_FAILED`, `ENTITY_DETAIL_EMPTY`, or `ENTITY_DETAIL_UNAVAILABLE` when the conversation or turn credentials needed to open panels are missing. Supports CN, HK, fallback answers and `html`. No extra credits; each follow-up answer gets its own panels. Rejected with 422 on other engines. Off by default.","uniqueKey":"oneOf.2.payload.include.entityDetails","typeLabel":"boolean"},"serp":{"type":"boolean","description":"NAVER_AI_BRIEF only. Adds the Naver results page beneath the briefing: `organicResults` (web documents), `shoppingResults` (price comparison products, ads excluded) and `contentResults` (blog, cafe, Knowledge iN, influencer, news and video results, ads excluded). Off by default, when the task returns the briefing only. No extra credits. Rejected with 422 on other engines.","uniqueKey":"oneOf.2.payload.include.serp","typeLabel":"boolean"},"inlineImages":{"type":"boolean","default":true,"description":"Answer engines. Set to false for `text` and `markdown` without the pictures the engine showed (``), in the answer, each follow-up answer and `aioverview`. The pictures stay in `images`; a video thumbnail link (`[](url)`) stays as `[title](url)`. An answer made only of pictures keeps them. A value that is not a boolean is rejected with 422.","uniqueKey":"oneOf.2.payload.include.inlineImages","typeLabel":"boolean"},"aioverview":{"type":"object","description":"Legacy GOOGLE flag. `aioverview.markdown: true` works like `include.markdown` on GOOGLE.","properties":{"markdown":{"type":"boolean","uniqueKey":"oneOf.2.payload.include.aioverview.markdown","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.payload.include.aioverview","typeLabel":"object"},"screenshot":{"type":"boolean","description":"No longer available. `true` is rejected with 400 VALIDATION_ERROR; use `html` for a page of the answer.","uniqueKey":"oneOf.2.payload.include.screenshot","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"oneOf.2.payload.include","typeLabel":"object"},"brand":{"type":"string","maxLength":200,"description":"With `include.analysis`: your brand's name, reported in `analysis.targets` with role `brand`.","uniqueKey":"oneOf.2.payload.brand","typeLabel":"string"},"brandAliases":{"type":"array","maxItems":20,"items":{"type":"string","maxLength":200,"uniqueKey":"oneOf.2.payload.brandAliases.items.[INDEX]","typeLabel":"string"},"description":"With `include.analysis` and `brand`: other names the answer may use for your brand.","uniqueKey":"oneOf.2.payload.brandAliases","typeLabel":"string[]"},"brandDomains":{"type":"array","maxItems":20,"items":{"type":"string","uniqueKey":"oneOf.2.payload.brandDomains.items.[INDEX]","typeLabel":"string"},"description":"With `include.analysis` and `brand`: your sites, such as `example.com`. A citation on one of them or a subdomain has `kind` `owned`.","example":["example.com"],"uniqueKey":"oneOf.2.payload.brandDomains","typeLabel":"string[]"},"competitors":{"type":"array","maxItems":50,"items":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.1.name","typeLabel":"string"},"aliases":{"type":"array","maxItems":20,"items":{"type":"string","maxLength":200,"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.1.aliases.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.1.aliases","typeLabel":"string[]"},"domains":{"type":"array","maxItems":20,"items":{"type":"string","uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.1.domains.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.1.domains","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.payload.competitors.items.[INDEX]","typeLabel":"string | object"},"description":"With `include.analysis`: competitors reported in `analysis.targets` with role `competitor`. A citation on one of their domains has `kind` `competitor`.","uniqueKey":"oneOf.2.payload.competitors","typeLabel":"(string | object)[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.2.payload","typeLabel":"object"},"idempotencyKey":{"type":"string","description":"Optional. Deduplicates submissions for at least 30 days after the request. Omit for no deduplication. A duplicate is a `409` on this endpoint, but a success on the batch endpoint.","uniqueKey":"oneOf.2.idempotencyKey","typeLabel":"string"},"priority":{"type":"integer","description":"Compatibility field; does not guarantee execution order. Values outside 1–10 are clamped, not rejected.","minimum":1,"maximum":10,"default":1,"uniqueKey":"oneOf.2.priority","typeLabel":"integer"},"webhook":{"type":"object","description":"Optional. Omit to collect the result by polling instead.","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Receives a POST when the task reaches a terminal state.","isRequired":true,"uniqueKey":"oneOf.2.webhook.url","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.2.webhook","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"googleSerpPage":{"title":"googleSerpPage","summary":"Google results page 2 with its saved page, searched from Austin, Texas","value":{"taskType":"GOOGLE_SERP","idempotencyKey":"check-42:page-2","payload":{"query":"best crm for small business","country":"US","page":2,"uule":"w+CAIQICIaQXVzdGluLFRleGFzLFVuaXRlZCBTdGF0ZXM","include":{"html":true}}}},"googlePlacesPage":{"title":"googlePlacesPage","summary":"Third page of Google Places, places 41 to 60 (1 credit)","value":{"taskType":"GOOGLE_PLACES","payload":{"query":"Reno attorney","city":"Reno, Nevada, United States","page":3}}},"llm":{"title":"llm","summary":"LLM engine (reads payload.prompt)","value":{"taskType":"GEMINI","idempotencyKey":"job-42:prompt-7:gemini","priority":1,"webhook":{"url":"https://your-server.example.com/hook"},"payload":{"prompt":"best wireless earbuds 2026","country":"US","include":{"markdown":true}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5cb3fb2c-7d8e-4391-9a74-c31cf3537289":{"description":"The task ended: the body `GET /v1/async/task/{id}` returns, with `response` or `error`. With `Accept: text/html`, the saved page of the completed task.","content":{"application/json":{"schema":{"type":"object","required":["success","task","credits"],"properties":{"success":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"task":{"type":"object","required":["id","taskType","status","priority","createdAt","latencyMs"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.id","typeLabel":"string\u003cuuid>"},"taskType":{"oneOf":[{"type":"string","description":"Task types returned by task polling, submissions, batch results and webhooks, including tasks created by dedicated endpoints. This is not a submission engine list.","enum":["CHATGPT","PERPLEXITY","GEMINI","AIMODE","GOOGLE_AIMODE","GOOGLE","GOOGLE_AIO","GOOGLE_SERP","GOOGLE_PLACES","GOOGLE_NEWS","NAVER_AI_BRIEF","NAVER_AI_TAB","NAVER_AI_MODE","NAVER","NAVER_SERP","COMMERCE_SERP","COMMERCE_PRODUCT","BING_SEARCH","BRAVE_SEARCH","BING","COPILOT","BING_COPILOT","MICROSOFT_COPILOT","BING_AIMODE","BING_COPILOT_SEARCH","COPILOT_SEARCH","META_AI","QWEN","DOUBAO","BAIDU_WENXIN","BAIDU_AI_SEARCH","CITATION_ANALYSIS","GEO_AUDIT","SOURCE_INFLUENCE","CITATION_ATTRIBUTION","PROMPT_RESEARCH","GEO_SCORE","SEARCH","WEB_SEARCH","WEB_SCRAPE"],"isRequired":true,"uniqueKey":"task.taskType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Task types returned by task polling, submissions, batch results and webhooks, including tasks created by dedicated endpoints. This is not a submission engine list.","enum":["AI_RENDERING"],"isRequired":true,"uniqueKey":"task.taskType.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"task.taskType","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"`PROCESSING` means a worker holds the task. `COMPLETED` and `FAILED` are terminal. For NAVER_AI_TAB with response.upstreamError, `COMPLETED` means collection finished; the answer may still be incomplete.","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"],"isRequired":true,"uniqueKey":"task.status","typeLabel":"enum\u003cstring>"},"priority":{"type":"integer","isRequired":true,"uniqueKey":"task.priority","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.createdAt","typeLabel":"string\u003cdate-time>"},"latencyMs":{"oneOf":[{"type":"integer","description":"Milliseconds from the worker's first pickup to the final outcome, excluding the queue wait. `null` until the task settles. Returned by polling, the webhook and the submit response alike.","isRequired":true,"uniqueKey":"task.latencyMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Milliseconds from the worker's first pickup to the final outcome, excluding the queue wait. `null` until the task settles. Returned by polling, the webhook and the submit response alike.","isRequired":true,"uniqueKey":"task.latencyMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.latencyMs","typeLabel":"integer | null"},"idempotencyKey":{"type":"string","description":"Echoed back verbatim. **Omitted**, not null, when the caller supplied none.","uniqueKey":"task.idempotencyKey","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task","typeLabel":"object"},"credits":{"type":"object","description":"Credits, with up to two decimals (for example `1.25`). The submit response always shows `0`: nothing is charged yet, and the task's price is held from your balance when it starts. Polling shows `0` until the task is terminal, then the settled charge: the task's price for COMPLETED, `0` for FAILED. A task webhook reports the same charge in `creditsCharged`; on a FAILED task it reports the task's price in `creditsToCharge` and `0` in `creditsCharged`. CITATION_ANALYSIS, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.","properties":{"creditsToCharge":{"type":"number","uniqueKey":"credits.creditsToCharge","typeLabel":"number"},"creditsCharged":{"oneOf":[{"type":"number","uniqueKey":"credits.creditsCharged.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"credits.creditsCharged.oneOf.1","typeLabel":"null"}],"uniqueKey":"credits.creditsCharged","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"credits","typeLabel":"object"},"response":{"type":"object","description":"The engine-specific result. Absent until the task is terminal. See the Engines guide for per-engine shapes. NAVER_AI_TAB preserves the original text, markdown, sources and cards when Naver returns HTTP success, a valid stream ending in done, and nonempty answer text with unknown_error. It includes upstreamError and returns immediately without retrying or rephrasing, even with retryQuery. COMPLETED means collection finished; the answer may still be incomplete. Empty, cut-off or malformed streams still fail. Policy refusals complete with a policy_declined notice. rawContent is returned only with include.rawResponse. With `include.citationAnalysis`, answer results also carry `citationAnalysis` (see Include). CITATION_ANALYSIS returns CitationAnalysisResult; see the Citation Analysis guide. PROMPT_RESEARCH returns PromptResearchResult; see the Prompt Research guide. GEO_SCORE returns GeoScoreResult; see the GEO Score guide. Answer engines with `include.analysis` add `analysis` (AnswerAnalysis).","properties":{"upstreamError":{"type":"object","description":"Optional NAVER_AI_TAB generation error accompanying preserved answer text. Collection finished, but the answer may be incomplete.","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"unknown_error","isRequired":true,"uniqueKey":"response.upstreamError.type","typeLabel":"string"},"message":{"type":"string","description":"Naver's exact notice text, without translation or rewording. Omitted when Naver provides no notice text.","uniqueKey":"response.upstreamError.message","typeLabel":"string"}},"uniqueKey":"response.upstreamError","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"response","typeLabel":"object"},"error":{"type":"string","description":"Present when `task.status` is `FAILED`. A plain string, not the `{code, message, timestamp}` object used by request-level errors.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"completed":{"title":"completed","summary":"Completed","value":{"success":true,"task":{"id":"8f2c1e40-0000-0000-0000-000000000000","taskType":"GEMINI","status":"COMPLETED","priority":1,"createdAt":"2026-07-09T04:12:00.000Z","latencyMs":8412},"credits":{"creditsToCharge":1.25,"creditsCharged":1.25},"response":{"text":"The best wireless earbuds in 2026 are ...","sources":[{"position":1,"url":"https://example.com/review","label":"Best earbuds, reviewed"}]}}},"naverUpstreamError":{"title":"naverUpstreamError","summary":"Naver answer preserved with an upstream error","description":"Collection finished; the answer may be incomplete.","value":{"success":true,"task":{"id":"8f2c1e40-0000-0000-0000-000000000000","taskType":"NAVER_AI_TAB","status":"COMPLETED","priority":1,"createdAt":"2026-07-09T04:12:00.000Z","latencyMs":8412},"credits":{"creditsToCharge":1.25,"creditsCharged":1.25},"response":{"text":"2","markdown":"2","sources":[],"upstreamError":{"type":"unknown_error"}}}},"failed":{"title":"failed","summary":"Failed: `error` is a string here, not an object","value":{"success":true,"task":{"id":"8f2c1e40-0000-0000-0000-000000000000","taskType":"GEMINI","status":"FAILED","priority":1,"createdAt":"2026-07-09T04:12:00.000Z","latencyMs":8412},"credits":{"creditsToCharge":0,"creditsCharged":0},"error":"ENGINE_TIMEOUT: The engine did not answer before the task deadline."}}},"exampleType":"examples"},"text/html":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"\u003c!doctype html>\n\u003c!-- Saved by querying.ai: the page Google Search served for task 8f2c1e40-... -->\n\u003chtml>...\u003c/html>","examples":{"Example":{"title":"Example","value":"\u003c!doctype html>\n\u003c!-- Saved by querying.ai: the page Google Search served for task 8f2c1e40-... -->\n\u003chtml>...\u003c/html>"}},"exampleType":"examples"}},"exampleType":"examples"},"09c0290f-312f-498b-926d-7a6de67a7ca8":{"description":"The task had not ended when the wait was over. It keeps running; poll `Location` or wait for the webhook.","headers":{"Location":{"description":"Where to poll the task: `/v1/async/task/{id}`.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["success","task","credits"],"properties":{"success":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"task":{"type":"object","required":["id","taskType","status","priority","createdAt","latencyMs"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.id","typeLabel":"string\u003cuuid>"},"taskType":{"oneOf":[{"type":"string","description":"Task types returned by task polling, submissions, batch results and webhooks, including tasks created by dedicated endpoints. This is not a submission engine list.","enum":["CHATGPT","PERPLEXITY","GEMINI","AIMODE","GOOGLE_AIMODE","GOOGLE","GOOGLE_AIO","GOOGLE_SERP","GOOGLE_PLACES","GOOGLE_NEWS","NAVER_AI_BRIEF","NAVER_AI_TAB","NAVER_AI_MODE","NAVER","NAVER_SERP","COMMERCE_SERP","COMMERCE_PRODUCT","BING_SEARCH","BRAVE_SEARCH","BING","COPILOT","BING_COPILOT","MICROSOFT_COPILOT","BING_AIMODE","BING_COPILOT_SEARCH","COPILOT_SEARCH","META_AI","QWEN","DOUBAO","BAIDU_WENXIN","BAIDU_AI_SEARCH","CITATION_ANALYSIS","GEO_AUDIT","SOURCE_INFLUENCE","CITATION_ATTRIBUTION","PROMPT_RESEARCH","GEO_SCORE","SEARCH","WEB_SEARCH","WEB_SCRAPE"],"isRequired":true,"uniqueKey":"task.taskType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Task types returned by task polling, submissions, batch results and webhooks, including tasks created by dedicated endpoints. This is not a submission engine list.","enum":["AI_RENDERING"],"isRequired":true,"uniqueKey":"task.taskType.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"task.taskType","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"`PROCESSING` means a worker holds the task. `COMPLETED` and `FAILED` are terminal. For NAVER_AI_TAB with response.upstreamError, `COMPLETED` means collection finished; the answer may still be incomplete.","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"],"isRequired":true,"uniqueKey":"task.status","typeLabel":"enum\u003cstring>"},"priority":{"type":"integer","isRequired":true,"uniqueKey":"task.priority","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.createdAt","typeLabel":"string\u003cdate-time>"},"latencyMs":{"oneOf":[{"type":"integer","description":"Milliseconds from the worker's first pickup to the final outcome, excluding the queue wait. `null` until the task settles. Returned by polling, the webhook and the submit response alike.","isRequired":true,"uniqueKey":"task.latencyMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Milliseconds from the worker's first pickup to the final outcome, excluding the queue wait. `null` until the task settles. Returned by polling, the webhook and the submit response alike.","isRequired":true,"uniqueKey":"task.latencyMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.latencyMs","typeLabel":"integer | null"},"idempotencyKey":{"type":"string","description":"Echoed back verbatim. **Omitted**, not null, when the caller supplied none.","uniqueKey":"task.idempotencyKey","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task","typeLabel":"object"},"credits":{"type":"object","description":"Credits, with up to two decimals (for example `1.25`). The submit response always shows `0`: nothing is charged yet, and the task's price is held from your balance when it starts. Polling shows `0` until the task is terminal, then the settled charge: the task's price for COMPLETED, `0` for FAILED. A task webhook reports the same charge in `creditsCharged`; on a FAILED task it reports the task's price in `creditsToCharge` and `0` in `creditsCharged`. CITATION_ANALYSIS, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.","properties":{"creditsToCharge":{"type":"number","uniqueKey":"credits.creditsToCharge","typeLabel":"number"},"creditsCharged":{"oneOf":[{"type":"number","uniqueKey":"credits.creditsCharged.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"credits.creditsCharged.oneOf.1","typeLabel":"null"}],"uniqueKey":"credits.creditsCharged","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"credits","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"task":{"id":"8f2c1e40-0000-0000-0000-000000000000","taskType":"GEMINI","status":"QUEUED","priority":1,"createdAt":"2026-07-09T04:12:00.000Z","latencyMs":null},"credits":{"creditsToCharge":0,"creditsCharged":0}},"examples":{"Example":{"title":"Example","value":{"success":true,"task":{"id":"8f2c1e40-0000-0000-0000-000000000000","taskType":"GEMINI","status":"QUEUED","priority":1,"createdAt":"2026-07-09T04:12:00.000Z","latencyMs":null},"credits":{"creditsToCharge":0,"creditsCharged":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"45dc1be3-7187-44ff-8ed4-39173986cf88":{"description":"`VALIDATION_ERROR`: malformed body, unrecognised `taskType`, a missing or invalid field (`details` names it), or an invalid `webhook.url`. `USE_DEDICATED_ENDPOINT`: CITATION_ANALYSIS and PROMPT_RESEARCH are created through `POST /v1/citation-analysis` and `POST /v1/prompt-research`, and a search through `POST /v1/search`. `CONVERSATION_EXPIRED`: the ChatGPT conversation named by `payload.continueFrom` can no longer be continued. With `Accept: text/html`, a body without `payload.include.html: true` is refused before a task is created (`details` names `payload.include.html`).","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"field":"payload.prompt","message":"payload.prompt or payload.query is required"}],"timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"field":"payload.prompt","message":"payload.prompt or payload.query is required"}],"timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"cd5295da-c9d3-449c-b695-8fd962a318d6":{"description":"Missing or invalid bearer token.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"MISSING_API_KEY","message":"Missing or invalid API key","timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"MISSING_API_KEY","message":"Missing or invalid API key","timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"8c8349b8-bd29-4db8-a2f5-b2df25c06d97":{"description":"`INSUFFICIENT_CREDITS`: the balance is below the price of the task.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"INSUFFICIENT_CREDITS","message":"insufficient credits (need 2)","timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INSUFFICIENT_CREDITS","message":"insufficient credits (need 2)","timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f00aa1df-232b-4ff7-bf09-27aec00cf05d":{"description":"`KEY_SCOPE_DENIED`: the engine is outside the key's Allowed engines. `ENGINE_PRIVATE`: the `taskType` is not available on self-serve plans; `details.availableTaskTypes` lists the ones that are.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"keyScope":{"title":"keyScope","summary":"Engine outside the key's scope","value":{"success":false,"error":{"code":"KEY_SCOPE_DENIED","message":"This API key is not allowed to submit taskType 'GEMINI'","timestamp":"2026-07-09T04:12:00.000Z"}}},"enginePrivate":{"title":"enginePrivate","summary":"Engine not sold on self-serve plans","value":{"success":false,"error":{"code":"ENGINE_PRIVATE","message":"taskType 'CLAUDE' is not available on self-serve plans","details":{"taskType":"CLAUDE","retryable":false,"availableTaskTypes":["CHATGPT","GEMINI","..."]},"timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"731710dc-0324-4531-b425-5cbf4be4eb32":{"description":"With `Accept: text/html`, the task ended without a saved page: it failed, or its page could not be saved. The body is the JSON answer, as in `200`.","content":{"application/json":{"schema":{"type":"object","required":["success","task","credits"],"properties":{"success":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"task":{"type":"object","required":["id","taskType","status","priority","createdAt","latencyMs"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.id","typeLabel":"string\u003cuuid>"},"taskType":{"oneOf":[{"type":"string","description":"Task types returned by task polling, submissions, batch results and webhooks, including tasks created by dedicated endpoints. This is not a submission engine list.","enum":["CHATGPT","PERPLEXITY","GEMINI","AIMODE","GOOGLE_AIMODE","GOOGLE","GOOGLE_AIO","GOOGLE_SERP","GOOGLE_PLACES","GOOGLE_NEWS","NAVER_AI_BRIEF","NAVER_AI_TAB","NAVER_AI_MODE","NAVER","NAVER_SERP","COMMERCE_SERP","COMMERCE_PRODUCT","BING_SEARCH","BRAVE_SEARCH","BING","COPILOT","BING_COPILOT","MICROSOFT_COPILOT","BING_AIMODE","BING_COPILOT_SEARCH","COPILOT_SEARCH","META_AI","QWEN","DOUBAO","BAIDU_WENXIN","BAIDU_AI_SEARCH","CITATION_ANALYSIS","GEO_AUDIT","SOURCE_INFLUENCE","CITATION_ATTRIBUTION","PROMPT_RESEARCH","GEO_SCORE","SEARCH","WEB_SEARCH","WEB_SCRAPE"],"isRequired":true,"uniqueKey":"task.taskType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Task types returned by task polling, submissions, batch results and webhooks, including tasks created by dedicated endpoints. This is not a submission engine list.","enum":["AI_RENDERING"],"isRequired":true,"uniqueKey":"task.taskType.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"task.taskType","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"`PROCESSING` means a worker holds the task. `COMPLETED` and `FAILED` are terminal. For NAVER_AI_TAB with response.upstreamError, `COMPLETED` means collection finished; the answer may still be incomplete.","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"],"isRequired":true,"uniqueKey":"task.status","typeLabel":"enum\u003cstring>"},"priority":{"type":"integer","isRequired":true,"uniqueKey":"task.priority","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.createdAt","typeLabel":"string\u003cdate-time>"},"latencyMs":{"oneOf":[{"type":"integer","description":"Milliseconds from the worker's first pickup to the final outcome, excluding the queue wait. `null` until the task settles. Returned by polling, the webhook and the submit response alike.","isRequired":true,"uniqueKey":"task.latencyMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Milliseconds from the worker's first pickup to the final outcome, excluding the queue wait. `null` until the task settles. Returned by polling, the webhook and the submit response alike.","isRequired":true,"uniqueKey":"task.latencyMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.latencyMs","typeLabel":"integer | null"},"idempotencyKey":{"type":"string","description":"Echoed back verbatim. **Omitted**, not null, when the caller supplied none.","uniqueKey":"task.idempotencyKey","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task","typeLabel":"object"},"credits":{"type":"object","description":"Credits, with up to two decimals (for example `1.25`). The submit response always shows `0`: nothing is charged yet, and the task's price is held from your balance when it starts. Polling shows `0` until the task is terminal, then the settled charge: the task's price for COMPLETED, `0` for FAILED. A task webhook reports the same charge in `creditsCharged`; on a FAILED task it reports the task's price in `creditsToCharge` and `0` in `creditsCharged`. CITATION_ANALYSIS, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.","properties":{"creditsToCharge":{"type":"number","uniqueKey":"credits.creditsToCharge","typeLabel":"number"},"creditsCharged":{"oneOf":[{"type":"number","uniqueKey":"credits.creditsCharged.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"credits.creditsCharged.oneOf.1","typeLabel":"null"}],"uniqueKey":"credits.creditsCharged","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"credits","typeLabel":"object"},"response":{"type":"object","description":"The engine-specific result. Absent until the task is terminal. See the Engines guide for per-engine shapes. NAVER_AI_TAB preserves the original text, markdown, sources and cards when Naver returns HTTP success, a valid stream ending in done, and nonempty answer text with unknown_error. It includes upstreamError and returns immediately without retrying or rephrasing, even with retryQuery. COMPLETED means collection finished; the answer may still be incomplete. Empty, cut-off or malformed streams still fail. Policy refusals complete with a policy_declined notice. rawContent is returned only with include.rawResponse. With `include.citationAnalysis`, answer results also carry `citationAnalysis` (see Include). CITATION_ANALYSIS returns CitationAnalysisResult; see the Citation Analysis guide. PROMPT_RESEARCH returns PromptResearchResult; see the Prompt Research guide. GEO_SCORE returns GeoScoreResult; see the GEO Score guide. Answer engines with `include.analysis` add `analysis` (AnswerAnalysis).","properties":{"upstreamError":{"type":"object","description":"Optional NAVER_AI_TAB generation error accompanying preserved answer text. Collection finished, but the answer may be incomplete.","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"unknown_error","isRequired":true,"uniqueKey":"response.upstreamError.type","typeLabel":"string"},"message":{"type":"string","description":"Naver's exact notice text, without translation or rewording. Omitted when Naver provides no notice text.","uniqueKey":"response.upstreamError.message","typeLabel":"string"}},"uniqueKey":"response.upstreamError","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"response","typeLabel":"object"},"error":{"type":"string","description":"Present when `task.status` is `FAILED`. A plain string, not the `{code, message, timestamp}` object used by request-level errors.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"task":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","taskType":"CHATGPT","status":"QUEUED","priority":123,"createdAt":"2023-11-07T05:31:56Z","latencyMs":123,"idempotencyKey":"\u003cstring>"},"credits":{"creditsToCharge":123,"creditsCharged":123},"response":{"upstreamError":{"type":"unknown_error","message":"\u003cstring>"}},"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"24a3c847-c9ac-419c-b67d-9570389f7edb":{"description":"A task with this `idempotencyKey` exists but is past its retention window, so its result can no longer be read. A key whose task can still be read is answered with that task instead.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"RESOURCE_ALREADY_EXISTS","message":"Task already exists.","details":{"taskId":"8f2c1e40-0000-0000-0000-000000000000"},"timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"RESOURCE_ALREADY_EXISTS","message":"Task already exists.","details":{"taskId":"8f2c1e40-0000-0000-0000-000000000000"},"timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c03b7951-dccd-4496-b8b7-7f995a483c32":{"description":"`PAYLOAD_TOO_LARGE`: the body exceeds 1 MiB. Rejected before parsing.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"PAYLOAD_TOO_LARGE","message":"request body exceeds 1 MiB","timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"PAYLOAD_TOO_LARGE","message":"request body exceeds 1 MiB","timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6ff09fee-3a53-4afb-9cbe-8cf57b128c7e":{"description":"The request is well-formed, but it cannot be served as asked. `REGION_UNSUPPORTED`: this engine never serves `payload.country`. `LOCATION_UNSUPPORTED`: the engine does not take `payload.state` or `payload.uule`. `EVIDENCE_UNSUPPORTED`: the engine cannot return `include.html`, or a CHATGPT task asks for it with `state`, country `CN` or `HK`, `continueFrom`, `webSearch: false` or `images`. `VALIDATION_ERROR` (422): an engine-specific field rule, such as a BING_SEARCH text over 4,000 characters, or `include.analysis` on an engine that does not support it.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"REGION_UNSUPPORTED","message":"PERPLEXITY cannot be served for country='CN' ...","details":{"taskType":"PERPLEXITY","country":"CN","retryable":false},"timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"REGION_UNSUPPORTED","message":"PERPLEXITY cannot be served for country='CN' ...","details":{"taskType":"PERPLEXITY","country":"CN","retryable":false},"timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1c1f656a-5050-490d-a525-a2efa4c6e99d":{"description":"Retry after the `Retry-After` header (seconds). `QUEUE_LIMIT_EXCEEDED`: the account already has 1,000,000 queued tasks. `KEY_DAILY_CREDIT_LIMIT`: the key used up its daily credit limit. `SUB_ACCOUNT_CREDIT_LIMIT`: the sub-account would exceed its `monthlyCreditLimit`. A task past the plan or contract concurrency limit is not refused: it is accepted, polls as `QUEUED`, and starts as running tasks finish.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"QUEUE_LIMIT_EXCEEDED","message":"Queue limit exceeded. Maximum 1000000 queued tasks allowed per account","details":{"limit":1000000,"retryAfterSec":30},"timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"QUEUE_LIMIT_EXCEEDED","message":"Queue limit exceeded. Maximum 1000000 queued tasks allowed per account","details":{"limit":1000000,"retryAfterSec":30},"timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6b56b0c4-8245-44c3-aa25-c8ac53dcc2e1":{"description":"Retry after the `Retry-After` header (seconds). `QUEUE_BACKPRESSURE`: this engine's queue is full. `SERVER_OVERLOADED`: admission is saturated, or the task queue as a whole is full. `DB_UNAVAILABLE`: task storage did not answer. `ENGINE_UNAVAILABLE`: this engine is temporarily not accepting tasks; `details.resumeAt`, when present, is when it expects to take tasks again. `EVIDENCE_UNAVAILABLE`: HTML pages of answers are not available right now.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable, safe to branch on. See the Errors guide for the full list.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For humans. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Context for the error. An array of `{field, message}` on most `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted when there is nothing to add.","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"object[] | object"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"DB_UNAVAILABLE","message":"Task storage unavailable. Retry shortly.","details":{"retryAfterSec":2,"retryable":true},"timestamp":"2026-07-09T04:12:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"DB_UNAVAILABLE","message":"Task storage unavailable. Retry shortly.","details":{"retryAfterSec":2,"retryable":true},"timestamp":"2026-07-09T04:12:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4887dbeb-be34-4005-a589-3b886b7d7629":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key, sent as `Authorization: Bearer \u003ckey>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"03c555ab-4c28-4095-a5ca-17c281dd6cf9":{"url":"https://api.querying.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key, sent as `Authorization: Bearer \u003ckey>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key, sent as `Authorization: Bearer \u003ckey>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"querying-ai","siteName":"querying.ai","title":"Run a task synchronously - querying.ai","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/sync-task","matchLevel":0},"ko":{"href":"/ko/api-reference/sync-task","matchLevel":1},"ja":{"href":"/ja/api-reference/sync-task","matchLevel":1},"zh":{"href":"/zh/api-reference/sync-task","matchLevel":1},"es":{"href":"/es/api-reference/sync-task","matchLevel":1},"fr":{"href":"/fr/api-reference/sync-task","matchLevel":1},"de":{"href":"/de/api-reference/sync-task","matchLevel":1},"pt":{"href":"/pt/api-reference/sync-task","matchLevel":1}}},"lastModified":"2026-11-18T05:35:36.290Z","originalFileLocation":"api-reference/sync-task.mdx","locale":"en"},"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=\"Submit a single task and get its result in the same request, within 290 seconds.\">\u003cmeta data-mint-head name=\"application-name\" content=\"querying.ai\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_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/querying-ai/2DfxV-wlBr1l-bh0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a task synchronously - querying.ai\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit a single task and get its result in the same request, within 290 seconds.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"querying.ai\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.querying.ai/api-reference/sync-task\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://querying-ai.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Run+a+task+synchronously\u0026amp;description=Submit+a+single+task+and+get+its+result+in+the+same+request%2C+within+290+seconds.\u0026amp;theme=a594992072db4a12a05c91e2\u0026amp;signature=776009db52fc97e08cb67b12a11870eea27c996f3df6ef61c3ec59e2167909f1\">\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=\"Run a task synchronously - querying.ai\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit a single task and get its result in the same request, within 290 seconds.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://querying-ai.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Run+a+task+synchronously\u0026amp;description=Submit+a+single+task+and+get+its+result+in+the+same+request%2C+within+290+seconds.\u0026amp;theme=a594992072db4a12a05c91e2\u0026amp;signature=776009db52fc97e08cb67b12a11870eea27c996f3df6ef61c3ec59e2167909f1\">\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/querying-ai/2DfxV-wlBr1l-bh0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"querying.ai\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003cmeta data-mint-head name=\"msvalidate.01\" content=\"D437239914CD88705CAB1AC77E85675C\">\u003cmeta data-mint-head name=\"naver-site-verification\" content=\"ffb29a85960a4eb3c417886940616c926a99e23a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.querying.ai/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sync-task.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.querying.ai/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.querying.ai/ko/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.querying.ai/ja/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.querying.ai/zh/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.querying.ai/es/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.querying.ai/fr/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.querying.ai/de/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.querying.ai/pt/api-reference/sync-task\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.querying.ai/api-reference/sync-task\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.querying.ai/#organization\",\"name\":\"querying.ai\",\"url\":\"https://docs.querying.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/querying-ai/hbPR_IODrQaVec6W/logo/light.svg?fit=max\u0026auto=format\u0026n=hbPR_IODrQaVec6W\u0026q=85\u0026s=e70eb9454629ff45d5bf908843a393ac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.querying.ai#website\",\"name\":\"querying.ai\",\"url\":\"https://docs.querying.ai\",\"publisher\":{\"@id\":\"https://docs.querying.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.querying.ai/api-reference/sync-task#webpage\",\"url\":\"https://docs.querying.ai/api-reference/sync-task\",\"name\":\"Run a task synchronously\",\"description\":\"Submit a single task and get its result in the same request, within 290 seconds.\",\"dateModified\":\"2026-11-18T05:35:36.290Z\",\"isPartOf\":{\"@id\":\"https://docs.querying.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.querying.ai/api-reference/sync-task#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.querying.ai/api-reference/sync-task#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tasks\",\"item\":\"https://docs.querying.ai/api-reference/create-task\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run a task synchronously\",\"item\":\"https://docs.querying.ai/api-reference/sync-task\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.querying.ai/api-reference/sync-task#apireference\",\"headline\":\"Run a task synchronously\",\"name\":\"Run a task synchronously\",\"description\":\"Submit a single task and get its result in the same request, within 290 seconds.\",\"url\":\"https://docs.querying.ai/api-reference/sync-task\",\"mainEntityOfPage\":{\"@id\":\"https://docs.querying.ai/api-reference/sync-task#webpage\"},\"dateModified\":\"2026-11-18T05:35:36.290Z\",\"publisher\":{\"@id\":\"https://docs.querying.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.querying.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"querying.ai\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"querying.ai\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sync-task.md","siteName":"querying.ai","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Tasks","pages":[{"title":"Create a task","description":"Queue a single task against one engine.","openapi":"POST /v1/async/task","href":"/api-reference/create-task"},{"title":"Run a task synchronously","openapi":"POST /v1/sync/task","href":"/api-reference/sync-task"},{"title":"Get a task","description":"Poll a task by id. Terminal results are available for 24 hours after completion.","openapi":"GET /v1/async/task/{id}","href":"/api-reference/get-task"},{"title":"Create tasks in bulk","openapi":"POST /v1/async/task/batch","href":"/api-reference/create-task-batch"}]},{"group":"Batches","pages":[{"title":"Create a batch","openapi":"POST /v1/batches","href":"/api-reference/create-batch"},{"title":"Get a batch","openapi":"GET /v1/batches/{id}","href":"/api-reference/get-batch"},{"title":"List batch items","openapi":"GET /v1/batches/{id}/items","href":"/api-reference/list-batch-items"}]},{"group":"Location grids","pages":[{"title":"Create a location grid","openapi":"POST /v1/async/task/grid","href":"/api-reference/create-task-grid"},{"title":"Get a location grid","openapi":"GET /v1/async/task/grid/{id}","href":"/api-reference/get-task-grid"}]},{"group":"Search","pages":[{"title":"Search","openapi":"POST /v1/search","href":"/api-reference/search"}]},{"group":"Research","pages":[{"title":"Prompt Research","openapi":"POST /v1/prompt-research","href":"/api-reference/prompt-research"},{"title":"GEO Score","openapi":"POST /v1/geo-score","href":"/api-reference/geo-score"},{"title":"Create a place lookup","openapi":"POST /v1/place-lookup","href":"/api-reference/place-lookup"},{"title":"Get a place lookup","openapi":"GET /v1/place-lookup/{id}","href":"/api-reference/get-place-lookup"}]},{"group":"AI Rendering","pages":[{"title":"Check a page","openapi":"POST /v1/ai-rendering/checks","href":"/api-reference/ai-rendering/create-check"},{"title":"Get a check","openapi":"GET /v1/ai-rendering/checks/{id}","href":"/api-reference/ai-rendering/get-check"},{"title":"List sites","openapi":"GET /v1/ai-rendering/sites","href":"/api-reference/ai-rendering/list-sites"},{"title":"Connect a site","openapi":"POST /v1/ai-rendering/sites","href":"/api-reference/ai-rendering/create-site"},{"title":"Get a site","openapi":"GET /v1/ai-rendering/sites/{id}","href":"/api-reference/ai-rendering/get-site"},{"title":"Update a site","openapi":"PATCH /v1/ai-rendering/sites/{id}","href":"/api-reference/ai-rendering/update-site"},{"title":"Remove a site","openapi":"DELETE /v1/ai-rendering/sites/{id}","href":"/api-reference/ai-rendering/delete-site"},{"title":"Get a new site key","openapi":"POST /v1/ai-rendering/sites/{id}/key","href":"/api-reference/ai-rendering/rotate-key"},{"title":"Publish a page","openapi":"POST /v1/ai-rendering/sites/{id}/pages","href":"/api-reference/ai-rendering/publish-page"},{"title":"Publish many pages","openapi":"POST /v1/ai-rendering/sites/{id}/pages/batch","href":"/api-reference/ai-rendering/publish-pages"},{"title":"List a site's pages","openapi":"GET /v1/ai-rendering/sites/{id}/pages","href":"/api-reference/ai-rendering/list-pages"},{"title":"Get a site's activity","openapi":"GET /v1/ai-rendering/sites/{id}/activity","href":"/api-reference/ai-rendering/get-activity"},{"title":"Get usage","openapi":"GET /v1/ai-rendering/usage","href":"/api-reference/ai-rendering/get-usage"},{"title":"Check a site","openapi":"POST /v1/ai-rendering/site-checks","href":"/api-reference/ai-rendering/check-site"},{"title":"Verify a site's integration","openapi":"POST /v1/ai-rendering/sites/{id}/verifications","href":"/api-reference/ai-rendering/create-verification"},{"title":"Get a verification","openapi":"GET /v1/ai-rendering/sites/{id}/verifications/{verificationId}","href":"/api-reference/ai-rendering/get-verification"},{"title":"List a site's verifications","openapi":"GET /v1/ai-rendering/sites/{id}/verifications","href":"/api-reference/ai-rendering/list-verifications"},{"title":"Take a page down","openapi":"DELETE /v1/ai-rendering/sites/{id}/pages/{pageId}","href":"/api-reference/ai-rendering/delete-page"},{"title":"List a site's copies","openapi":"GET /v1/ai-rendering/copies","href":"/api-reference/ai-rendering/list-copies"}]},{"group":"Monitors","pages":[{"title":"List monitors","openapi":"GET /v1/monitors","href":"/api-reference/monitors/list-monitors"},{"title":"Create a monitor","openapi":"POST /v1/monitors","href":"/api-reference/monitors/create-monitor"},{"title":"Get a monitor","openapi":"GET /v1/monitors/{id}","href":"/api-reference/monitors/get-monitor"},{"title":"Update a monitor","openapi":"PATCH /v1/monitors/{id}","href":"/api-reference/monitors/update-monitor"},{"title":"Delete a monitor","openapi":"DELETE /v1/monitors/{id}","href":"/api-reference/monitors/delete-monitor"},{"title":"Run a monitor now","openapi":"POST /v1/monitors/{id}/run","href":"/api-reference/monitors/run-monitor"},{"title":"Get monitor analytics","openapi":"GET /v1/monitors/{id}/analytics","href":"/api-reference/monitors/get-analytics"},{"title":"List cited sources","openapi":"GET /v1/monitors/{id}/sources","href":"/api-reference/monitors/list-sources"},{"title":"Get citations over time","openapi":"GET /v1/monitors/{id}/citations","href":"/api-reference/monitors/get-citations"},{"title":"Get a scored answer","openapi":"GET /v1/monitors/{id}/answers/{taskId}","href":"/api-reference/monitors/get-answer"},{"title":"Get a prompt","openapi":"GET /v1/monitors/{id}/prompt","href":"/api-reference/monitors/get-prompt"},{"title":"Export scored answers","openapi":"GET /v1/monitors/{id}/results","href":"/api-reference/monitors/export-results"},{"title":"Get a monitor's answers by location","openapi":"GET /v1/monitors/{id}/grid","href":"/api-reference/monitors/get-grid"},{"title":"List change events","openapi":"GET /v1/monitors/{id}/events","href":"/api-reference/monitors/list-events"},{"title":"Redeliver a change event","openapi":"POST /v1/monitors/{id}/events/{eventId}/redeliver","href":"/api-reference/monitors/redeliver-event"},{"title":"Get alert history","openapi":"GET /v1/monitors/{id}/alerts","href":"/api-reference/monitors/get-alerts"},{"title":"Send a test alert","openapi":"POST /v1/monitors/{id}/alerts/test","href":"/api-reference/monitors/test-alert"},{"title":"Get monitor capabilities","openapi":"GET /v1/monitors/capabilities","href":"/api-reference/monitors/get-capabilities"},{"title":"Suggest prompts","openapi":"POST /v1/monitors/suggest","href":"/api-reference/monitors/suggest-prompts"},{"title":"Research prompts for a monitor","openapi":"POST /v1/monitors/research","href":"/api-reference/monitors/research-prompts"},{"title":"Get report sharing","openapi":"GET /v1/monitors/{id}/share","href":"/api-reference/monitors/get-share"},{"title":"Share a report","openapi":"PUT /v1/monitors/{id}/share","href":"/api-reference/monitors/update-share"}]},{"group":"Exports","pages":[{"title":"List exports","openapi":"GET /v1/exports","href":"/api-reference/exports/list-exports"},{"title":"Create an export","openapi":"POST /v1/exports","href":"/api-reference/exports/create-export"},{"title":"Get the export identity","openapi":"GET /v1/exports/identity","href":"/api-reference/exports/get-identity"},{"title":"Get an export","openapi":"GET /v1/exports/{id}","href":"/api-reference/exports/get-export"},{"title":"Pause or resume an export","openapi":"PATCH /v1/exports/{id}","href":"/api-reference/exports/update-export"},{"title":"Delete an export","openapi":"DELETE /v1/exports/{id}","href":"/api-reference/exports/delete-export"},{"title":"List delivery history","openapi":"GET /v1/exports/{id}/runs","href":"/api-reference/exports/list-runs"},{"title":"Retry a delivery window","openapi":"POST /v1/exports/{id}/runs/{runId}/retry","href":"/api-reference/exports/retry-run"}]},{"group":"Sub-accounts","pages":[{"title":"List sub-accounts","openapi":"GET /v1/sub-accounts","href":"/api-reference/sub-accounts/list-sub-accounts"},{"title":"Create a sub-account","openapi":"POST /v1/sub-accounts","href":"/api-reference/sub-accounts/create-sub-account"},{"title":"Get a sub-account","openapi":"GET /v1/sub-accounts/{id}","href":"/api-reference/sub-accounts/get-sub-account"},{"title":"Update or suspend a sub-account","openapi":"PATCH /v1/sub-accounts/{id}","href":"/api-reference/sub-accounts/update-sub-account"},{"title":"List a sub-account's keys","openapi":"GET /v1/sub-accounts/{id}/keys","href":"/api-reference/sub-accounts/list-keys"},{"title":"Issue a sub-account key","openapi":"POST /v1/sub-accounts/{id}/keys","href":"/api-reference/sub-accounts/issue-key"},{"title":"Revoke a sub-account key","openapi":"DELETE /v1/sub-accounts/{id}/keys/{keyId}","href":"/api-reference/sub-accounts/revoke-key"},{"title":"Get a sub-account's usage","openapi":"GET /v1/sub-accounts/{id}/usage","href":"/api-reference/sub-accounts/get-usage"},{"title":"List usage of every sub-account","openapi":"GET /v1/sub-accounts/usage","href":"/api-reference/sub-accounts/list-usage"}]},{"group":"Operations","pages":[{"title":"Engine capabilities","openapi":"GET /v1/capabilities","href":"/api-reference/capabilities"},{"title":"List of countries","openapi":"GET /v1/countries","href":"/api-reference/countries"},{"title":"List of states","openapi":"GET /v1/states","href":"/api-reference/states"},{"title":"Credit balance","openapi":"GET /v1/credits","href":"/api-reference/credits"},{"title":"Credit usage","openapi":"GET /v1/usage","href":"/api-reference/usage"},{"title":"Queue status","openapi":"GET /v1/async/status","href":"/api-reference/queue-status"},{"title":"Resolve a Google redirect","openapi":"POST /v1/google/goto","href":"/api-reference/google-goto"},{"title":"Clear queue","openapi":"DELETE /v1/async/queue","href":"/api-reference/clear-queue"},{"title":"Liveness probe","openapi":"GET /health","href":"/api-reference/health"},{"title":"Readiness probe","openapi":"GET /ready","href":"/api-reference/ready"},{"title":"Task counts for your account","sidebarTitle":"Stats","openapi":"GET /stats","href":"/api-reference/stats"},{"title":"ChatGPT serving mode","sidebarTitle":"Capacity","openapi":"GET /capacity","href":"/api-reference/capacity"}]}]}]},{"language":"ko","pages":[{"title":"ko","href":"/ko/api-reference/sync-task"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api-reference/sync-task"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/sync-task"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/sync-task"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/sync-task"}]},{"language":"de","pages":[{"title":"de","href":"/de/api-reference/sync-task"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt/api-reference/sync-task"}]}]},"basePath":"","title":"Run a task synchronously - querying.ai","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","Page-Cr9IwkK7.js","CodeSnippet-eoRjC4Le.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","getApiPlaygroundDisplay-CZyAPlR2.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}