Returns the latest Prompt Studio generation for the workspace. Suggestions come
in order: the 20 recommendations first, then the rest of the scored pool. By
default the response contains the 20 recommendations. Set limit to read more
of the pool, up to 500 suggestions; total gives the size of the whole pool.
When no generation exists yet, run is absent and suggestions is an empty array; start one with
Generate prompt suggestions.Available on Growth, Agency Growth, Business, Agency Business and Enterprise plans. See Authentication.
string
required
Bearer token for your team.
string
required
Workspace identifier. The workspace must belong to the token’s team.
string
default:"balanced"
balanced, DISCOVERY, CONSIDERATION, PERCEPTION or AUTHORITY.
integer
default:"20"
Maximum number of suggestions returned, recommendations first. An integer from 1 to 500.
Response
object
The generation these suggestions come from. Absent when no generation exists yet. Same fields as
Get a suggestion generation.
string
The focus applied to the ordering
integer
Number of suggestions in the whole pool for this focus, whatever the limit
array
The recommendations first, then the rest of the pool, cut at limit.
Existing topic identifier, when the suggested topic is already configured
string | null
Funnel stage of the prompt
string | null
Search intent of the prompt
integer
Suggestion score from 0 to 100
string | null
Why the prompt was suggested
boolean
Whether the suggestion is one of the 20 recommendations
boolean
true when an equivalent prompt is active and monitored. An equivalent archived or paused prompt reads false: accepting the suggestion reactivates that prompt and reports created
focus is not one of the listed values, or limit is not an integer from 1 to 500
401
Flat body
Missing or invalid token
403
INSUFFICIENT_PLAN
Generic plan refusal: “This endpoint is not included in the team’s plan.”
404
BRAND_NOT_FOUND
The workspace is missing or inaccessible
Read errors use the flat or nested shapes described in Error codes. On 429, honor Retry-After.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Qwairy Documentation","colors":{"primary":"#7b3aee","light":"#9f6aff","dark":"#6930c3"},"logo":{"light":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531","dark":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/dark.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=785d06dbaa640b3277a1ccb1db2681f4"},"favicon":"https://mintcdn.com/qwairy/iJ9osnRZHsYMWu0z/favicon.svg?fit=max\u0026auto=format\u0026n=iJ9osnRZHsYMWu0z\u0026q=85\u0026s=ce439f6d1ab0e2580c3e94fffa248755","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://www.qwairy.co"}},"navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.qwairy.co/dashboard"}},"search":{"prompt":"Search documentation..."},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"documentation/get-started/what-is-qwairy"},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co/dashboard"}},"href":"fr/documentation/get-started/what-is-qwairy"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qwairy","hasAudioNarration":false,"actualSubdomain":"qwairy","customDomains":["docs.qwairy.co"],"gitSource":{"type":"github","owner":"nicolasilhe","repo":"docs.qwairy.co","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff3fdd8b67b28b9f2a7ce1","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"API","count":101},{"language":"fr","tag":"API","count":101},{"language":"en","tag":"Product","count":77},{"language":"fr","tag":"Produit","count":77},{"language":"en","tag":"Use cases","count":72},{"language":"fr","tag":"Cas d’usage","count":72},{"language":"en","tag":"MCP","count":39},{"language":"fr","tag":"MCP","count":39},{"language":"en","tag":"Configure data","count":27},{"language":"fr","tag":"Configurer les données","count":27},{"language":"en","tag":"Monitor and measure","count":25},{"language":"fr","tag":"Suivi et mesure","count":25},{"language":"en","tag":"Measure","count":23},{"language":"fr","tag":"Measure","count":23},{"language":"en","tag":"Get started","count":21},{"language":"fr","tag":"Bien démarrer","count":21},{"language":"en","tag":"Changelog","count":20},{"language":"en","tag":"Release notes","count":20},{"language":"fr","tag":"Nouveautés","count":20},{"language":"fr","tag":"Notes de version","count":20}]},"assistantConfig":{},"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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":"#navigation-items,#navigation-items *{hyphens:manual}#content a[id]:not([href]){scroll-margin-top:var(--scroll-mt, 152px)}"}]}
{"page":{"pagePath":"developers/endpoints/prompt-suggestions/get","slug":"/developers/endpoints/prompt-suggestions/get","pageMetadata":{"title":"Get prompt suggestions","description":"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.","api":"GET /api/v1/brands/{brandId}/prompt-suggestions","href":"/developers/endpoints/prompt-suggestions/get"},"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: \"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns the latest Prompt Studio generation for the workspace. Suggestions come\nin order: the 20 recommendations first, then the rest of the scored pool. By\ndefault the response contains the 20 recommendations. Set `,_jsx(_components.code,{children:`limit`}),` to read more\nof the pool, up to 500 suggestions; `,_jsx(_components.code,{children:`total`}),` gives the size of the whole pool.\nWhen no generation exists yet, `,_jsx(_components.code,{children:`run`}),` is absent and `,_jsx(_components.code,{children:`suggestions`}),` is an empty array; start one with\n`,_jsx(_components.a,{href:`/developers/endpoints/prompt-suggestions/generate`,children:`Generate prompt suggestions`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Available on Growth, Agency Growth, Business, Agency Business and Enterprise plans. See `,_jsx(_components.a,{href:`/developers/authentication`,children:`Authentication`}),`.`]}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsx(_components.p,{children:`Bearer token for your team.`})}),`\n`,_jsx(ParamField,{path:`brandId`,type:`string`,required:true,id:`param-brand-id`,children:_jsx(_components.p,{children:`Workspace identifier. The workspace must belong to the token’s team.`})}),`\n`,_jsx(ParamField,{query:`focus`,type:`string`,default:`balanced`,id:`param-focus`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`balanced`}),`, `,_jsx(_components.code,{children:`DISCOVERY`}),`, `,_jsx(_components.code,{children:`CONSIDERATION`}),`, `,_jsx(_components.code,{children:`PERCEPTION`}),` or `,_jsx(_components.code,{children:`AUTHORITY`}),`.`]})}),`\n`,_jsx(ParamField,{query:`limit`,type:`integer`,default:`20`,id:`param-limit`,children:_jsx(_components.p,{children:`Maximum number of suggestions returned, recommendations first. An integer from 1 to 500.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`run`,type:`object`,id:`param-run`,children:_jsxs(_components.p,{children:[`The generation these suggestions come from. Absent when no generation exists yet. Same fields as\n`,_jsx(_components.a,{href:`/developers/endpoints/prompt-suggestions/get-run`,children:`Get a suggestion generation`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`focus`,type:`string`,id:`param-focus-1`,children:`The focus applied to the ordering`}),`\n`,_jsx(ResponseField,{name:`total`,type:`integer`,id:`param-total`,children:`Number of suggestions in the whole pool for this focus, whatever the limit`}),`\n`,_jsxs(ResponseField,{name:`suggestions`,type:`array`,id:`param-suggestions`,children:[_jsxs(_components.p,{children:[`The recommendations first, then the rest of the pool, cut at `,_jsx(_components.code,{children:`limit`}),`.`]}),_jsxs(Expandable,{title:`Suggestion`,children:[_jsxs(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:[`Suggestion identifier, used by `,_jsx(_components.a,{href:`/developers/endpoints/prompt-suggestions/accept`,children:`Accept prompt suggestions`})]}),_jsx(ResponseField,{name:`text`,type:`string`,id:`param-text`,children:`Suggested prompt text`}),_jsx(ResponseField,{name:`topic`,type:`string | null`,id:`param-topic`,children:`Suggested topic name`}),_jsx(ResponseField,{name:`keywordId`,type:`string | null`,id:`param-keyword-id`,children:`Existing topic identifier, when the suggested topic is already configured`}),_jsx(ResponseField,{name:`funnelStage`,type:`string | null`,id:`param-funnel-stage`,children:`Funnel stage of the prompt`}),_jsx(ResponseField,{name:`intent`,type:`string | null`,id:`param-intent`,children:`Search intent of the prompt`}),_jsx(ResponseField,{name:`score`,type:`integer`,id:`param-score`,children:`Suggestion score from 0 to 100`}),_jsx(ResponseField,{name:`reason`,type:`string | null`,id:`param-reason`,children:`Why the prompt was suggested`}),_jsx(ResponseField,{name:`recommended`,type:`boolean`,id:`param-recommended`,children:`Whether the suggestion is one of the 20 recommendations`}),_jsxs(ResponseField,{name:`tracked`,type:`boolean`,id:`param-tracked`,children:[_jsx(_components.code,{children:`true`}),` when an equivalent prompt is active and monitored. An equivalent archived or paused prompt reads `,_jsx(_components.code,{children:`false`}),`: accepting the suggestion reactivates that prompt and reports `,_jsx(_components.code,{children:`created`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`synthetic-request-and-response`,children:`Synthetic request and response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://www.qwairy.co/api/v1/brands/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$BRAND_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/prompt-suggestions?focus=DISCOVERY\u0026limit=1\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$QWAIRY_API_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`27`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`27`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"run\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"bbbbbbbb-0000-4000-8000-000000000000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"COMPLETED\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"manual\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keywordId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"recommendations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`20`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-12T09:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"completedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-12T09:02:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"focus\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"DISCOVERY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`48`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"suggestions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cccccccc-0000-4000-8000-000000000000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"text\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Which CRM tools support small sales teams?\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"topic\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CRM software\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keywordId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"funnelStage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TOFU\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"intent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Discovery\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"score\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`88`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Covers a common comparison question for the category.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"recommended\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tracked\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_PARAMETER`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`focus`}),` is not one of the listed values, or `,_jsx(_components.code,{children:`limit`}),` is not an integer from 1 to 500`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Flat body`}),_jsx(_components.td,{children:`Missing or invalid token`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INSUFFICIENT_PLAN`})}),_jsx(_components.td,{children:`Generic plan refusal: “This endpoint is not included in the team’s plan.”`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`BRAND_NOT_FOUND`})}),_jsx(_components.td,{children:`The workspace is missing or inaccessible`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Read errors use the flat or nested shapes described in `,_jsx(_components.a,{href:`/developers/errors`,children:`Error codes`}),`. On `,_jsx(_components.code,{children:`429`}),`, honor `,_jsx(_components.code,{children:`Retry-After`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get prompt suggestions","description":"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.","api":"GET /api/v1/brands/{brandId}/prompt-suggestions","href":"/developers/endpoints/prompt-suggestions/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Synthetic request and response","slug":"synthetic-request-and-response","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get prompt suggestions","path":"/api/v1/brands/{brandId}/prompt-suggestions","servers":[{"url":"https://www.qwairy.co"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{"focus":{"schema":[{"type":"string","description":"`balanced` , `DISCOVERY` , `CONSIDERATION` , `PERCEPTION` or `AUTHORITY` ."}]},"limit":{"schema":[{"type":"integer","description":"Maximum number of suggestions returned, recommendations first. An integer from 1 to 500."}]}},"header":{"Authorization":{"schema":[{"type":"string","description":"Bearer token for your team.","required":true}]}},"cookie":{},"path":{"brandId":{"schema":[{"type":"string","description":"Workspace identifier. The workspace must belong to the token’s team.","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"run":[{"type":"object","properties":{},"description":"The generation these suggestions come from. Absent when no generation exists yet. Same fields as Get a suggestion generation ."}],"focus":[{"type":"string","description":"The focus applied to the ordering"}],"total":[{"type":"integer","description":"Number of suggestions in the whole pool for this focus, whatever the limit"}],"suggestions":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"string","description":"Suggestion identifier, used by Accept prompt suggestions"}],"text":[{"type":"string","description":"Suggested prompt text"}],"topic":[{"type":"object","properties":{},"description":"Suggested topic name"}],"keywordId":[{"type":"object","properties":{},"description":"Existing topic identifier, when the suggested topic is already configured"}],"funnelStage":[{"type":"object","properties":{},"description":"Funnel stage of the prompt"}],"intent":[{"type":"object","properties":{},"description":"Search intent of the prompt"}],"score":[{"type":"integer","description":"Suggestion score from 0 to 100"}],"reason":[{"type":"object","properties":{},"description":"Why the prompt was suggested"}],"recommended":[{"type":"boolean","description":"Whether the suggestion is one of the 20 recommendations"}],"tracked":[{"type":"boolean","description":"`true` when an equivalent prompt is active and monitored. An equivalent archived or paused prompt reads `false` : accepting the suggestion reactivates that prompt and reports `created`"}]}}],"description":"The recommendations first, then the rest of the pool, cut at `limit` ."}]}}],"examples":{"example":{"value":{"run":{},"focus":"\u003cstring>","total":123,"suggestions":[{"id":"\u003cstring>","text":"\u003cstring>","topic":{},"keywordId":{},"funnelStage":{},"intent":{},"score":123,"reason":{},"recommended":true,"tracked":true}]}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"qwairy","siteName":"Qwairy Documentation","title":"Get prompt suggestions - Qwairy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/developers/endpoints/prompt-suggestions/get","matchLevel":0},"fr":{"href":"/fr/developers/endpoints/prompt-suggestions/get","matchLevel":1}}},"lastModified":"2026-11-19T18:28:58.730Z","originalFileLocation":"developers/endpoints/prompt-suggestions/get.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=\"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get prompt suggestions - Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Prompt+suggestions\u0026amp;title=Get+prompt+suggestions\u0026amp;description=Read+the+latest+Prompt+Studio+generation+for+a+workspace%3A+the+20+recommendations+by+default%2C+more+of+the+scored+pool+with+limit%2C+and+the+pool+size.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=4e2db5a119b0f7f21aad2790d03954ce41303542c8b0f8a32590d7294d7b6199\">\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=\"Get prompt suggestions - Qwairy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Prompt+suggestions\u0026amp;title=Get+prompt+suggestions\u0026amp;description=Read+the+latest+Prompt+Studio+generation+for+a+workspace%3A+the+20+recommendations+by+default%2C+more+of+the+scored+pool+with+limit%2C+and+the+pool+size.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=4e2db5a119b0f7f21aad2790d03954ce41303542c8b0f8a32590d7294d7b6199\">\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/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7b3aee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/endpoints/prompt-suggestions/get.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.qwairy.co/fr/developers/endpoints/prompt-suggestions/get\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qwairy.co/#organization\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qwairy.co#website\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get#webpage\",\"url\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\",\"name\":\"Get prompt suggestions\",\"description\":\"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.\",\"dateModified\":\"2026-11-19T18:28:58.730Z\",\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Configure data\",\"item\":\"https://docs.qwairy.co/developers/endpoints/brands/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get prompt suggestions\",\"item\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get#apireference\",\"headline\":\"Get prompt suggestions\",\"name\":\"Get prompt suggestions\",\"description\":\"Read the latest Prompt Studio generation for a workspace: the 20 recommendations by default, more of the scored pool with limit, and the pool size.\",\"url\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get#webpage\"},\"dateModified\":\"2026-11-19T18:28:58.730Z\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Qwairy Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Qwairy Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/endpoints/prompt-suggestions/get.md","siteName":"Qwairy Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Product","pages":[{"title":"Product","href":"/documentation/get-started/what-is-qwairy"}]},{"tab":"API","groups":[{"group":"Get started","pages":[{"title":"Introduction","icon":"book-open","href":"/developers/introduction"},{"title":"Endpoint catalog","href":"/developers/endpoints/index"},{"title":"Quick start","href":"/developers/guides/index"},{"title":"Authentication","icon":"key","href":"/developers/authentication"},{"title":"API tokens","href":"/developers/api-keys"},{"title":"Writing data","icon":"pen-to-square","href":"/developers/writing-data"},{"title":"Rate limits","icon":"gauge","href":"/developers/rate-limits"},{"title":"Error codes","icon":"triangle-exclamation","href":"/developers/errors"},{"title":"Entities","icon":"cubes","href":"/developers/entities"}]},{"group":"Configure data","pages":[{"group":"Brands","pages":[{"title":"List brands","api":"GET /api/v1/brands","href":"/developers/endpoints/brands/list"},{"title":"Get brand","api":"GET /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/get"},{"title":"Create a workspace","api":"POST /api/v1/brands","href":"/developers/endpoints/brands/create"},{"title":"Update a workspace","api":"PATCH /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/update"},{"title":"Get monitoring","api":"GET /api/v1/brands/{brandId}/monitoring","href":"/developers/endpoints/brands/monitoring"},{"title":"Update monitoring","api":"PATCH /api/v1/brands/{brandId}/monitoring","href":"/developers/endpoints/brands/update-monitoring"}]},{"group":"Topics","pages":[{"title":"List topics","api":"GET /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/list"},{"title":"Get a topic","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/get"},{"title":"Create a topic","api":"POST /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/manage"},{"title":"Update a topic","api":"PATCH /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/update"},{"title":"Delete a topic","api":"DELETE /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/delete"},{"title":"Topic evolution","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}/evolution","href":"/developers/endpoints/keywords/evolution"}]},{"group":"Tags","pages":[{"title":"List tags","api":"GET /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/list"},{"title":"Get a tag","api":"GET /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/get"},{"title":"Create a tag","api":"POST /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/create"},{"title":"Update a tag","api":"PATCH /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/update"},{"title":"Delete a tag","api":"DELETE /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/delete"},{"title":"Tag evolution","description":"Get daily time-series metrics for one tag, including Mention Rate, Source Rate, and Share of Voice at the response level for the selected period.","api":"GET /api/v1/brands/{brandId}/tags/{tagId}/evolution","href":"/developers/endpoints/tags/evolution"}]},{"group":"Prompt suggestions","pages":[{"title":"Get prompt suggestions","api":"GET /api/v1/brands/{brandId}/prompt-suggestions","href":"/developers/endpoints/prompt-suggestions/get"},{"title":"Generate prompt suggestions","description":"Start a Prompt Studio generation for a workspace or one topic. It uses no customer credits, returns 202, and is limited per workspace over 24 hours.","api":"POST /api/v1/brands/{brandId}/prompt-suggestions/runs","href":"/developers/endpoints/prompt-suggestions/generate"},{"title":"Get a suggestion generation","api":"GET /api/v1/brands/{brandId}/prompt-suggestions/runs/{suggestionRunId}","href":"/developers/endpoints/prompt-suggestions/get-run"},{"title":"Accept prompt suggestions","api":"POST /api/v1/brands/{brandId}/prompt-suggestions/accept","href":"/developers/endpoints/prompt-suggestions/accept"}]},{"title":"Estimate a run","api":"POST /api/v1/brands/{brandId}/runs/estimate","href":"/developers/endpoints/runs/estimate"},{"title":"Start a run","api":"POST /api/v1/brands/{brandId}/runs","href":"/developers/endpoints/runs/manage"},{"title":"List runs","api":"GET /api/v1/brands/{brandId}/runs","href":"/developers/endpoints/runs/list"},{"title":"Get a run","api":"GET /api/v1/brands/{brandId}/runs/{runId}","href":"/developers/endpoints/runs/get"},{"title":"Credits","api":"GET /api/v1/credits","href":"/developers/endpoints/credits"}]},{"group":"Monitor and measure","pages":[{"group":"Performance","pages":[{"title":"Get performance snapshot","api":"GET /api/v1/brands/{brandId}/performance","href":"/developers/endpoints/performance"},{"title":"Get GEO matrix","api":"GET /api/v1/brands/{brandId}/matrix","href":"/developers/endpoints/matrix"}]},{"group":"Prompts","pages":[{"title":"List prompts","api":"GET /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/list"},{"title":"Get prompt","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/get"},{"title":"Prompt answers","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/answers","href":"/developers/endpoints/prompts/answers"},{"title":"Prompt evolution","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/evolution","href":"/developers/endpoints/prompts/evolution"},{"title":"Create a prompt","api":"POST /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/manage"},{"title":"Update a prompt","api":"PATCH /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/update"},{"title":"Bulk update prompts","api":"POST /api/v1/brands/{brandId}/prompts/bulk","href":"/developers/endpoints/prompts/bulk"}]},{"group":"Answers","pages":[{"title":"List answers","api":"GET /api/v1/brands/{brandId}/answers","href":"/developers/endpoints/answers/list"},{"title":"Get answer","api":"GET /api/v1/brands/{brandId}/answers/{answerId}","href":"/developers/endpoints/answers/get"}]},{"group":"Competitors","pages":[{"title":"List competitors","api":"GET /api/v1/brands/{brandId}/competitors","href":"/developers/endpoints/competitors/list"},{"title":"Get competitor","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}","href":"/developers/endpoints/competitors/get"},{"title":"Competitor evolution","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}/evolution","href":"/developers/endpoints/competitors/evolution"}]},{"group":"Sources","pages":[{"title":"List source domains","api":"GET /api/v1/brands/{brandId}/source-domains","href":"/developers/endpoints/source-domains/list"},{"title":"Get source domain","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}","href":"/developers/endpoints/source-domains/get"},{"title":"Source domain evolution","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}/evolution","href":"/developers/endpoints/source-domains/evolution"},{"title":"List source URLs","api":"GET /api/v1/brands/{brandId}/source-urls","href":"/developers/endpoints/source-urls"}]},{"group":"Signals","pages":[{"title":"List query fan-out records","api":"GET /api/v1/brands/{brandId}/search","href":"/developers/endpoints/search"},{"title":"List follow-ups","api":"GET /api/v1/brands/{brandId}/follow-ups","href":"/developers/endpoints/follow-ups"},{"title":"List shopping results","api":"GET /api/v1/brands/{brandId}/shopping","href":"/developers/endpoints/shopping"},{"title":"List local business insights","api":"GET /api/v1/brands/{brandId}/local","href":"/developers/endpoints/local"},{"title":"List social signals","api":"GET /api/v1/brands/{brandId}/social","href":"/developers/endpoints/social"},{"title":"List sponsored content","api":"GET /api/v1/brands/{brandId}/sponsored","href":"/developers/endpoints/sponsored"}]},{"title":"Get crawler analytics","api":"GET /api/v1/brands/{brandId}/crawler-analytics","href":"/developers/endpoints/crawler-analytics"}]},{"group":"Analyze and act","pages":[{"group":"Perception","pages":[{"title":"List perception snapshots","api":"GET /api/v1/brands/{brandId}/perception","href":"/developers/endpoints/perception/list"},{"title":"Get perception snapshot","api":"GET /api/v1/brands/{brandId}/perception/{snapshotId}","href":"/developers/endpoints/perception/get"}]},{"group":"Actions","pages":[{"title":"List actions","api":"GET /api/v1/brands/{brandId}/actions","href":"/developers/endpoints/actions/list"},{"title":"Update an action status","api":"PATCH /api/v1/brands/{brandId}/actions/{actionId}","href":"/developers/endpoints/actions/update-status"}]},{"group":"Content","pages":[{"title":"List content","api":"GET /api/v1/brands/{brandId}/content","href":"/developers/endpoints/content/list"},{"title":"Get content","api":"GET /api/v1/brands/{brandId}/content/{articleId}","href":"/developers/endpoints/content/get"}]},{"title":"Get Site Readiness analysis","api":"GET /api/v1/brands/{brandId}/technical-analysis","href":"/developers/endpoints/technical-analysis"},{"group":"Site diagnostics","pages":[{"title":"List monitored pages","api":"GET /api/v1/brands/{brandId}/site-diagnostics","href":"/developers/endpoints/site-diagnostics/list"},{"title":"Get a monitored page","api":"GET /api/v1/brands/{brandId}/site-diagnostics/{pageId}","href":"/developers/endpoints/site-diagnostics/get"},{"title":"Add pages to monitor","api":"POST /api/v1/brands/{brandId}/site-diagnostics/pages","href":"/developers/endpoints/site-diagnostics/add-pages"},{"title":"Start a page audit","api":"POST /api/v1/brands/{brandId}/site-diagnostics/audits","href":"/developers/endpoints/site-diagnostics/start-audit"},{"title":"Get a page audit","api":"GET /api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}","href":"/developers/endpoints/site-diagnostics/get-audit"}]}]},{"group":"Agency and automation","pages":[{"group":"Pitch audits","pages":[{"title":"Create a Pitch Audit","api":"POST /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/create"},{"title":"Save Pitch Audit prompts","api":"PATCH /api/v1/pitch-audits/{auditId}/prompts","href":"/developers/endpoints/pitch-audits/save-prompts"},{"title":"Confirm a Pitch Audit","api":"POST /api/v1/pitch-audits/{auditId}/confirm","href":"/developers/endpoints/pitch-audits/confirm"},{"title":"List Pitch Audits","api":"GET /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/list"},{"title":"Get Pitch Audit","api":"GET /api/v1/pitch-audits/{auditId}","href":"/developers/endpoints/pitch-audits/get"},{"title":"Get Pitch Audit subject report","api":"GET /api/v1/pitch-audits/{auditId}/reports/{subjectId}","href":"/developers/endpoints/pitch-audits/get-report"}]},{"title":"Outbound webhooks","href":"/developers/webhooks"}]},{"group":"Integration webhooks","pages":[{"title":"Integration webhooks","href":"/developers/integration-webhooks/overview"},{"title":"Integration webhook events","href":"/developers/integration-webhooks/events"},{"title":"Verify webhook signatures","href":"/developers/integration-webhooks/verify-signatures"},{"group":"Webhook endpoints","pages":[{"title":"List webhook endpoints","api":"GET /api/v1/webhooks","href":"/developers/endpoints/webhooks/list"},{"title":"Create a webhook endpoint","api":"POST /api/v1/webhooks","href":"/developers/endpoints/webhooks/create"},{"title":"Get a webhook endpoint","api":"GET /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/get"},{"title":"Update a webhook endpoint","api":"PATCH /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/update"},{"title":"Delete a webhook endpoint","api":"DELETE /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/delete"},{"title":"Rotate the signing secret","api":"POST /api/v1/webhooks/{webhookId}/rotate-secret","href":"/developers/endpoints/webhooks/rotate-secret"},{"title":"Send a test event","api":"POST /api/v1/webhooks/{webhookId}/test","href":"/developers/endpoints/webhooks/test"},{"title":"List deliveries","api":"GET /api/v1/webhooks/{webhookId}/deliveries","href":"/developers/endpoints/webhooks/deliveries"},{"title":"Redeliver an event","api":"POST /api/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver","href":"/developers/endpoints/webhooks/redeliver"}]}]},{"group":"Implementation guides","pages":[{"title":"Custom dashboard","href":"/developers/guides/custom-dashboard"},{"title":"Weekly reports","href":"/developers/guides/weekly-reports"},{"title":"Competitive analysis","href":"/developers/guides/competitive-analysis"},{"title":"Data export","href":"/developers/guides/data-export"},{"title":"Onboard a client with the API","href":"/developers/guides/onboard-client-api"},{"title":"Sync prompts from a spreadsheet with n8n","href":"/developers/guides/sync-prompts-n8n"},{"title":"Update an action, then audit pages","href":"/developers/guides/page-audit-site-diagnostics"},{"title":"Run a Pitch Audit for a prospect with MCP","href":"/developers/guides/pitch-audit-prospect-mcp"},{"title":"Add prompt suggestions with MCP","href":"/developers/guides/prompt-suggestions-mcp"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"Looker Studio","pages":[{"title":"Looker Studio","href":"/looker-studio/getting-started"}]},{"tab":"Agencies","pages":[{"title":"Agencies","href":"/agencies/introduction"}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/use-cases"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/updates/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.qwairy.co/blog"},{"anchor":"GEO Guide","icon":"book-open","href":"https://www.qwairy.co/guides/complete-guide-to-generative-engine-optimization"}]}},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co/dashboard"}},"pages":[{"title":"fr","href":"/fr/developers/endpoints/prompt-suggestions/get"}]}]},"basePath":"","title":"Get prompt suggestions - Qwairy Documentation","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"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","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}