Get prompt
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/prompts/{promptId} \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/prompts/{promptId}"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/prompts/{promptId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Prompts
Get prompt
Retrieve one prompt with response-level metrics and up to 100 aggregated query fan-outs, with an include option for mention and citation aggregates.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
prompts
/
{promptId}
Get prompt
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/prompts/{promptId} \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/prompts/{promptId}"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/prompts/{promptId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Returns one prompt with response-level metrics and up to 100 aggregated query fan-outs. Use
Synthetic response with
See Rate limits for retry behavior.
include=details for mention and citation aggregates.
Path parameters
Query parameters
Set to
details to enrich the prompt with aggregated competitors, sources, brand mentions, and source stability metrics. When omitted, returns the base fields only.Response
The base object includesanswersCount, Mention Rate, Source Rate, SELF avgSentiment, and these query-fan-out fields:
queryFanOutsTotal: total distinct normalized queriesqueryFanOutsLimit: maximum rows returned, currently100queryFanOuts:query,occurrences,uniqueAnswers, rawmodels,firstSeen, andlastSeen
personas (id, name, description), modelIds, monitoringEnabled, the effective frequency (NONE, DAILY, WEEKLY, or MONTHLY), frequencyInherited when that frequency comes from the brand default, and boostCount, the number of responses requested per model and run.
Synthetic response
{
"success": true,
"prompt": {
"id": "prompt_01",
"text": "Which analytics platforms support warehouse exports?",
"topic": {
"id": "topic_01",
"name": "Data exports"
},
"type": "TOFU",
"tags": [
{ "id": "tag1", "name": "reviews" },
{ "id": "tag2", "name": "comparison" }
],
"personas": [
{ "id": "persona_01", "name": "Data lead", "description": null }
],
"modelIds": ["openai-gpt-6.1-sol"],
"monitoringEnabled": true,
"frequency": "WEEKLY",
"frequencyInherited": true,
"boostCount": 1,
"answersCount": 2,
"mentionRate": 50.0,
"sourceRate": 25.0,
"avgSentiment": 78.5,
"queryFanOutsTotal": 1,
"queryFanOutsLimit": 100,
"queryFanOuts": [
{
"query": "analytics warehouse export integrations",
"occurrences": 2,
"uniqueAnswers": 2,
"models": ["openai-gpt-6.1-sol"],
"firstSeen": "2026-07-18T10:00:00.000Z",
"lastSeen": "2026-07-19T10:00:00.000Z"
}
],
"createdAt": "2026-07-01T10:00:00.000Z",
"lastGeneratedAt": "2026-07-19T10:00:00.000Z"
}
}
Synthetic response with include=details
{
"success": true,
"prompt": {
"id": "prompt_01",
"text": "Which analytics platforms support warehouse exports?",
"topic": {
"id": "topic_01",
"name": "Data exports"
},
"type": "TOFU",
"tags": [
{ "id": "tag1", "name": "reviews" },
{ "id": "tag2", "name": "comparison" }
],
"personas": [
{ "id": "persona_01", "name": "Data lead", "description": null }
],
"modelIds": ["openai-gpt-6.1-sol"],
"monitoringEnabled": true,
"frequency": "WEEKLY",
"frequencyInherited": true,
"boostCount": 1,
"answersCount": 2,
"mentionRate": 50.0,
"sourceRate": 25.0,
"avgSentiment": 78.5,
"queryFanOutsTotal": 1,
"queryFanOutsLimit": 100,
"queryFanOuts": [],
"createdAt": "2026-07-01T10:00:00.000Z",
"lastGeneratedAt": "2026-07-19T10:00:00.000Z",
"competitors": [
{ "name": "Acme Analytics", "mentions": 3, "relationship": "SELF" },
{ "name": "Rival Labs", "mentions": 8, "relationship": "DIRECT" }
],
"competitorsCount": 2,
"competitorMentionsTotal": 11,
"brandMentioned": true,
"brandMentionCount": 3,
"sources": [
{ "domain": "acme.example", "citations": 2, "isSelf": true },
{ "domain": "reviews.example", "citations": 4, "isSelf": false }
],
"sourcesCount": 2,
"sourceCitationsTotal": 6,
"sourceStability": 50.0
}
}
Errors
| Status | Meaning |
|---|---|
401 | Missing or invalid API token |
404 | Brand or prompt not found |
429 | Rate limit exceeded; honor Retry-After |

