Prompts
Get a prompt
Read one prompt by id: its text, category, theme and market, whether it is tracked, and its volume and difficulty.
/v1/brands/{brand_id}/prompts/{prompt_id}One prompt of the brand.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
Path parameters
brand_idstringrequiredThe brand id, from GET /v1/brands.
prompt_idstringrequiredThe prompt id, from GET /v1/brands/{brand_id}/prompts.
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/prompts/PROMPT_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
A question in the brand's prompt library: tracked, paused or never run.
idstringtextstringcategorystringOne of discovery, problem_solution, use_case, expert, comparison, brand_research.
statusstringtracked: asked on every run.paused: tracked before, not asked now, its answers kept.never_run: not tracked, and never switched on since tracking dates began to be recorded (March 2026), so a prompt tracked only before then and paused since also readsnever_run, as on the dashboard. One oftracked,paused,never_run.themeobject or nullShow 2 fields insideHide the fields inside
idstringnamestring
locationstring or nullThe market the prompt is asked from, as stored.
is_brandedbooleanWhether the prompt was recorded as naming the brand when it was generated or added; a prompt added by hand is recorded as not. The text is not re-checked.
volumeinteger or nullEstimated search volume, 1-5.
difficultyinteger or nullHow crowded its answers are with competitors, 0-5: measured once a run asks it, estimated before.
created_atstringRFC 3339 timestamp in UTC.
activated_atstring or nullRFC 3339 timestamp in UTC. When it was first tracked. Null for a prompt never tracked, and for one first tracked before March 2026, when this date began to be recorded.
Response headers
X-Request-IdThe request id; quote it to support.
RateLimitRequests left in this window and seconds until it resets.
RateLimit-PolicyThe key's limit per window.
Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.