Create a prompt
curl --request POST \
--url https://www.qwairy.co/api/v1/brands/{brandId}/prompts \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"text": "<string>"
}
'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/prompts"
payload = { "text": "<string>" }
headers = {
"Authorization": "<authorization>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({text: '<string>'})
};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/prompts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Prompts
Create a prompt
Add a monitored prompt with an optional schedule, topic, tags, countries and models. Creating a prompt does not start billable answer collection.
POST
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
prompts
Create a prompt
curl --request POST \
--url https://www.qwairy.co/api/v1/brands/{brandId}/prompts \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"text": "<string>"
}
'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/prompts"
payload = { "text": "<string>" }
headers = {
"Authorization": "<authorization>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({text: '<string>'})
};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/prompts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Creates a prompt without starting billable answer collection.
Use Start a run to request fresh answers
for a live workspace.
Requires an active Business, Agency Business or Enterprise plan. Use an API token with write access enabled. See Writing data for
idempotency, conditional requests and error handling.
NONE, DAILY, WEEKLY, MONTHLY, or null. Omit or use null to
inherit the workspace schedule.Up to 50 tag UUIDs from this workspace. Defaults to no tags. In a workspace created from v1.21,
Qwairy sets the
Branded or Non-branded system tag from the prompt text.
The id of either system tag is ignored if you send it.Up to 50 uppercase two-letter country codes from the workspace country
catalog, the countries this prompt runs in. Omit it or send an empty array to
use the workspace default country. Manage the catalog with
Update a workspace.
Up to 30 model identifiers for this prompt only. Omit it or send an empty
array to use the workspace models.
Response
Returns201 with Location, ETag and a prompt containing id,
text, status, nullable frequency, monitoringEnabled, nullable
keywordId, tagIds, countryCodes, modelIds, version, createdAt
and updatedAt. A new prompt has status: ACTIVE. In a workspace created from v1.21 it also carries one system tag, so tagIds
includes its id; a workspace created earlier has no system tags. countryCodes and
modelIds echo what the prompt stores: an empty array means the prompt uses
the workspace default country or models.
Synthetic request and response
curl -X POST "https://www.qwairy.co/api/v1/brands/$BRAND_ID/prompts" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN" \
-H "Idempotency-Key: prompt-crm-001" \
-H "Content-Type: application/json" \
-d '{"text":"Which CRM tools support small sales teams?","frequency":"WEEKLY"}'
{
"prompt":{
"id":"33333333-0000-4000-8000-000000000000",
"text":"Which CRM tools support small sales teams?",
"status":"ACTIVE",
"frequency":"WEEKLY",
"monitoringEnabled":true,
"keywordId":null,
"tagIds":["55555555-0000-4000-8000-000000000000"],
"countryCodes":[],
"modelIds":[],
"version":0,
"createdAt":"2026-09-01T09:00:00.000Z",
"updatedAt":"2026-09-01T09:00:00.000Z"
}
}
Related operations
- Update, archive or restore a prompt.
- Bulk update prompts.
- List prompts with
view=configurationto retrieve editable fields and archived prompts.
Errors
Invalid fields return400 INVALID_REQUEST; inaccessible workspace or label
IDs return 404 RESOURCE_NOT_FOUND. Duplicate text, including an archived
prompt with the same text, returns 409 CONFLICT; restore the archived prompt
instead of recreating it.
See Error codes for authentication, plan, idempotency
and server errors. On 429, honor Retry-After; writes can return
503 SERVICE_UNAVAILABLE if the write limiter is unavailable.
