Your API key, sent as Authorization: Bearer <key>.
Body
application/json
seed
string
required
The topic: letters, digits and single spaces, such as sunscreen. A short product or category term works best; a sentence finds nothing.
Required string length: 1 - 30
country
enum<string>
required
Market: KR (South Korea) or US (United States). Any other value is a 422 REGION_UNSUPPORTED.
Available options:
KR,
US
limit
integer
default:20
Prompts to return, at least depth + 1.
Required range: 1 <= x <= 100
depth
integer
default:2
The most conditions one prompt combines. Every depth from 0 up to it is returned: 0 is each product kind's plain ask, 1 adds one condition (a budget, an answer to one of the kind's questions, a searched variant), and 2 and 3 combine conditions from different questions.
Required range: 0 <= x <= 3
cores
string[]
Product kinds to research in place of the ones the research picks, with the seed's rules. Spellings that differ only in case or spacing count once.
Required array length: 1 - 5 elements
Required string length: 1 - 30
exclude
string[]
Terms to leave out, such as a subtopic you do not want. A prompt containing one is left out. Put your own brand in brand.
Maximum array length: 20
Required string length: 1 - 30
brand
string
Your brand, with at least two letters or digits; punctuation is allowed. Prompts containing it are left out, as with exclude.
Required string length: 1 - 80
brandAliases
string[]
Other names or spellings of your brand, left out the same way. Requires brand.
Maximum array length: 10
Required string length: 1 - 80
brandDescription
string
What your brand sells and to whom. Requires brand. Adds fit to every prompt, favors the prompts your brand answers and leaves out the ones it rules out.
Maximum string length: 500
idempotencyKey
string
Optional. Deduplicates submissions for at least 30 days after the request; a duplicate is a 409.
priority
integer
default:1
Optional. Echoed in task metadata; values outside 1-10 are clamped. It does not guarantee execution order.
Required range: 1 <= x <= 10
webhook
object
Optional. Omit to collect the result by polling instead.
Show child attributes
Response
Queued; poll /v1/async/task/{id}. Its response follows PromptResearchResult.
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.
{"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/prompt-research","slug":"/api-reference/prompt-research","pageMetadata":{"title":"Prompt Research","description":"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.","openapi":"POST /v1/prompt-research","href":"/api-reference/prompt-research"},"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: \"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.\"\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":"Prompt Research","description":"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.","openapi":"POST /v1/prompt-research","href":"/api-reference/prompt-research"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/querying-ai/50db3c2a8c6df10f/pretendard.js","/_mintlify/custom/querying-ai/076e6719f53a8bea/sidebar-scroll.js"],"openApiReferenceData":{"operation":{"summary":"Research prompts by search demand","operationId":"createPromptResearch","tags":["Research"],"description":"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.","requestBody":"dee29a5f-8415-464d-8e18-57b7b322a644","responses":{"200":"7914dc73-f5aa-4bcf-8224-3862df2033f4","400":"5deafdda-59f5-490e-9639-0951899814ea","401":"7a822e15-5dde-46c7-826a-00069d31090e","402":"468d9b3f-32b6-45a4-8c01-cd183633855e","403":"7f82a211-2dd8-49a4-85b8-0d5294ce0151","409":"cec9c911-bea0-48a6-bfd4-3522ce960f7a","413":"c4df9028-d80b-46aa-b999-20d8d6a80588","422":"2e275d1a-1f09-4bd5-8f63-68f819886319","429":"ec022500-97d9-4915-b604-34230fefa641","503":"aaf82e78-b28e-4558-a22f-af05eb7069dd"},"method":"post","type":"path","servers":["03c555ab-4c28-4095-a5ca-17c281dd6cf9"],"security":["4887dbeb-be34-4005-a589-3b886b7d7629"],"path":"/v1/prompt-research","baseUrlOptions":["https://api.querying.ai"],"title":"Research prompts by search demand","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["seed","country"],"additionalProperties":false,"properties":{"seed":{"type":"string","minLength":1,"maxLength":30,"description":"The topic: letters, digits and single spaces, such as sunscreen. A short product or category term works best; a sentence finds nothing.","isRequired":true,"uniqueKey":"seed","typeLabel":"string"},"country":{"type":"string","enum":["KR","US"],"description":"Market: KR (South Korea) or US (United States). Any other value is a 422 REGION_UNSUPPORTED.","isRequired":true,"uniqueKey":"country","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Prompts to return, at least depth + 1.","uniqueKey":"limit","typeLabel":"integer"},"depth":{"type":"integer","minimum":0,"maximum":3,"default":2,"description":"The most conditions one prompt combines. Every depth from 0 up to it is returned: 0 is each product kind's plain ask, 1 adds one condition (a budget, an answer to one of the kind's questions, a searched variant), and 2 and 3 combine conditions from different questions.","uniqueKey":"depth","typeLabel":"integer"},"cores":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","minLength":1,"maxLength":30,"uniqueKey":"cores.items.[INDEX]","typeLabel":"string"},"description":"Product kinds to research in place of the ones the research picks, with the seed's rules. Spellings that differ only in case or spacing count once.","uniqueKey":"cores","typeLabel":"string[]"},"exclude":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":30,"uniqueKey":"exclude.items.[INDEX]","typeLabel":"string"},"description":"Terms to leave out, such as a subtopic you do not want. A prompt containing one is left out. Put your own brand in brand.","uniqueKey":"exclude","typeLabel":"string[]"},"brand":{"type":"string","minLength":1,"maxLength":80,"description":"Your brand, with at least two letters or digits; punctuation is allowed. Prompts containing it are left out, as with exclude.","uniqueKey":"brand","typeLabel":"string"},"brandAliases":{"type":"array","maxItems":10,"items":{"type":"string","minLength":1,"maxLength":80,"uniqueKey":"brandAliases.items.[INDEX]","typeLabel":"string"},"description":"Other names or spellings of your brand, left out the same way. Requires brand.","uniqueKey":"brandAliases","typeLabel":"string[]"},"brandDescription":{"type":"string","maxLength":500,"description":"What your brand sells and to whom. Requires brand. Adds fit to every prompt, favors the prompts your brand answers and leaves out the ones it rules out.","uniqueKey":"brandDescription","typeLabel":"string"},"idempotencyKey":{"type":"string","description":"Optional. Deduplicates submissions for at least 30 days after the request; a duplicate is a 409.","uniqueKey":"idempotencyKey","typeLabel":"string"},"priority":{"type":"integer","minimum":1,"maximum":10,"default":1,"description":"Optional. Echoed in task metadata; values outside 1-10 are clamped. It does not guarantee execution order.","uniqueKey":"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":"webhook.url","typeLabel":"string\u003curi>"}},"uniqueKey":"webhook","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"seed":{"title":"seed","summary":"A seed topic","value":{"seed":"sunscreen","country":"US","limit":20,"depth":2,"brand":"MyBrand"}},"described":{"title":"described","summary":"With your brand described","value":{"seed":"sunscreen","country":"US","limit":30,"depth":3,"brand":"MyBrand","brandAliases":["My Brand"],"brandDescription":"Gentle mineral sunscreens for sensitive and dry skin"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"7914dc73-f5aa-4bcf-8224-3862df2033f4":{"description":"Queued; poll /v1/async/task/{id}. Its response follows PromptResearchResult.","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"},"examples":{"queued":{"title":"queued","summary":"Queued prompt research","value":{"success":true,"task":{"id":"4299622a-1321-43a9-b780-809a0116f1b5","taskType":"PROMPT_RESEARCH","status":"QUEUED","priority":1,"createdAt":"2026-09-28T13:03:26.092Z","latencyMs":null},"credits":{"creditsToCharge":0,"creditsCharged":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"5deafdda-59f5-490e-9639-0951899814ea":{"description":"Request rejected: the body is not valid JSON.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7a822e15-5dde-46c7-826a-00069d31090e":{"description":"Request rejected.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"468d9b3f-32b6-45a4-8c01-cd183633855e":{"description":"Not enough credits.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7f82a211-2dd8-49a4-85b8-0d5294ce0151":{"description":"The API key is not allowed to use PROMPT_RESEARCH.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"cec9c911-bea0-48a6-bfd4-3522ce960f7a":{"description":"A task with this idempotencyKey already exists.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c4df9028-d80b-46aa-b999-20d8d6a80588":{"description":"Request rejected.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2e275d1a-1f09-4bd5-8f63-68f819886319":{"description":"VALIDATION_ERROR for a field out of range or for brandAliases or brandDescription without brand, or REGION_UNSUPPORTED when country is not KR or US.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ec022500-97d9-4915-b604-34230fefa641":{"description":"Request rejected; retry after Retry-After.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"aaf82e78-b28e-4558-a22f-af05eb7069dd":{"description":"Request rejected; retry after Retry-After.","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"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":"Prompt Research - querying.ai","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/prompt-research","matchLevel":0},"ko":{"href":"/ko/api-reference/prompt-research","matchLevel":1},"ja":{"href":"/ja/api-reference/prompt-research","matchLevel":1},"zh":{"href":"/zh/api-reference/prompt-research","matchLevel":1},"es":{"href":"/es/api-reference/prompt-research","matchLevel":1},"fr":{"href":"/fr/api-reference/prompt-research","matchLevel":1},"de":{"href":"/de/api-reference/prompt-research","matchLevel":1},"pt":{"href":"/pt/api-reference/prompt-research","matchLevel":1}}},"lastModified":"2026-11-09T07:17:58.040Z","originalFileLocation":"api-reference/prompt-research.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=\"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.\">\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=\"Prompt Research - querying.ai\">\u003cmeta data-mint-head property=\"og:description\" content=\"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.\">\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/prompt-research\">\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=Research\u0026amp;title=Prompt+Research\u0026amp;description=Queue+a+task+that+turns+a+topic+into+the+prompts+buyers+send+AI+assistants%2C+with+the+search+demand+behind+each+one.\u0026amp;theme=a594992072db4a12a05c91e2\u0026amp;signature=7c4ea1c5be0fc2a042b7d6ac3302f41580da46273d8fc3613ee61b9615813d12\">\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=\"Prompt Research - querying.ai\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://querying-ai.mintlify.site/_mintlify/api/og/v2?division=Research\u0026amp;title=Prompt+Research\u0026amp;description=Queue+a+task+that+turns+a+topic+into+the+prompts+buyers+send+AI+assistants%2C+with+the+search+demand+behind+each+one.\u0026amp;theme=a594992072db4a12a05c91e2\u0026amp;signature=7c4ea1c5be0fc2a042b7d6ac3302f41580da46273d8fc3613ee61b9615813d12\">\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/prompt-research\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/prompt-research.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.querying.ai/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.querying.ai/ko/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.querying.ai/ja/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.querying.ai/zh/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.querying.ai/es/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.querying.ai/fr/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.querying.ai/de/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.querying.ai/pt/api-reference/prompt-research\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.querying.ai/api-reference/prompt-research\">\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/prompt-research#webpage\",\"url\":\"https://docs.querying.ai/api-reference/prompt-research\",\"name\":\"Prompt Research\",\"description\":\"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.\",\"dateModified\":\"2026-11-09T07:17:58.040Z\",\"isPartOf\":{\"@id\":\"https://docs.querying.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.querying.ai/api-reference/prompt-research#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.querying.ai/api-reference/prompt-research#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"querying.ai\",\"item\":\"https://docs.querying.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Prompt Research\",\"item\":\"https://docs.querying.ai/api-reference/prompt-research\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.querying.ai/api-reference/prompt-research#apireference\",\"headline\":\"Prompt Research\",\"name\":\"Prompt Research\",\"description\":\"Queue a task that turns a topic into the prompts buyers send AI assistants, with the search demand behind each one.\",\"url\":\"https://docs.querying.ai/api-reference/prompt-research\",\"mainEntityOfPage\":{\"@id\":\"https://docs.querying.ai/api-reference/prompt-research#webpage\"},\"dateModified\":\"2026-11-09T07:17:58.040Z\",\"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/prompt-research.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","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","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","description":"Search the web and get each result with the passages of the page that answer the query, in the same call. type picks a standard search (0.5 credits) or a pro search (2 credits).","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","description":"Find what ChatGPT can't read on a page and what to fix first. The score, from 0 to 100, is the share of what a person reads that is also in the page fetched with the OAI-SearchBot user agent.","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/prompt-research"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api-reference/prompt-research"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/prompt-research"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/prompt-research"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/prompt-research"}]},{"language":"de","pages":[{"title":"de","href":"/de/api-reference/prompt-research"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt/api-reference/prompt-research"}]}]},"basePath":"","title":"Prompt Research - 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"]}