/ubersuggest/keywords/prompts

POST /api/ubersuggest/keywords/prompts

Price: 1 credit

Get AI search (LLM) prompt ideas for a keyword plus aggregated brands, citations and intents

How to use it

Get AI-search-visibility data for a keyword: LLM-generated prompt ideas (with the model that produced each, its inferred intents and mentioned brands), plus aggregated brand mentions, citation sources and intent distribution across the prompts. Use this to understand how generative-AI engines talk about a topic and which brands they surface. Resolve the loc_id with the locations search endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Keyword to generate AI search prompt ideas for (examples: "coffee maker", "crm software"; minLength: 1)
• lang string — Keyword language (default: "en"; one of: "en", "es", "de", "fr", "it", "pt", "nl", "pl", "ru", "ja", "hi")
• loc_id integer — Location id (resolve via the locations search endpoint, e.g. 2840 for the United States) (default: 2840; examples: 2840; min: 1)

Response

• @type string (default: "UbersuggestKeywordPrompts")
• keyword string required
• prompts array (default: [])
  • @type string (default: "UbersuggestPrompt")
  • prompt string required
  • provider string nullable
  • intents array (default: [])
  • brands array (default: [])
  • created_at integer nullable
• brands array (default: [])
  • @type string (default: "UbersuggestPromptBrand")
  • name string required
  • count integer nullable
  • providers array (default: [])
• citations array (default: [])
• intents object (default: {})
  • * integer

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.