Créer un 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
Créer un prompt
Ajoutez un prompt suivi, avec calendrier, Topic, Tags, pays et modèles facultatifs. Créer un prompt ne lance pas de collecte de réponses facturable.
POST
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
prompts
Créer un 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));Crée un prompt sans lancer de collecte de réponses facturable. Utilisez Lancer un run pour demander de nouvelles réponses pour un workspace live.
Nécessite une offre Business, Agency Business ou Enterprise active. Utilisez un jeton d’API dont l’accès en écriture est activé. Consultez Écrire des données pour l’idempotence, les requêtes conditionnelles et la gestion des erreurs.
Clé unique pour cette opération. Les réponses terminées sont rejouées pendant 24 heures.
Texte du prompt, 1 à 500 caractères après suppression des espaces en bordure, comme dans le dashboard.
NONE, DAILY, WEEKLY, MONTHLY, ou null. Omettez-le ou utilisez null pour hériter du calendrier du workspace.UUID d’un Topic de ce workspace. Omettez-le ou utilisez null pour créer un prompt non affecté.
Jusqu’à 50 UUID de Tags de ce workspace. Aucun Tag par défaut. Dans un workspace créé à partir de la v1.21, Qwairy pose le Tag système
Branded ou Non-branded d’après le texte du prompt. L’identifiant de l’un ou l’autre Tag système est ignoré si vous l’envoyez.Jusqu’à 50 codes de pays en majuscules sur deux lettres issus du catalogue de pays du workspace, les pays dans lesquels ce prompt s’exécute. Omettez-le ou envoyez un tableau vide pour utiliser le pays par défaut du workspace. Gérez le catalogue avec Mettre à jour un workspace.
Jusqu’à 30 identifiants de modèles pour ce prompt uniquement. Omettez-le ou envoyez un tableau vide pour utiliser les modèles du workspace.
Réponse
Renvoie201 avec Location, ETag et un prompt contenant id, text, status, frequency (nullable), monitoringEnabled, keywordId (nullable), tagIds, countryCodes, modelIds, version, createdAt et updatedAt. Un nouveau prompt a status: ACTIVE. Dans un workspace créé à partir de la v1.21, il porte aussi un Tag système : tagIds inclut donc son identifiant ; un workspace créé avant n’a pas de Tags système. countryCodes et modelIds reprennent ce que le prompt enregistre : un tableau vide signifie que le prompt utilise le pays ou les modèles par défaut du workspace.
Requête et réponse synthétiques
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"
}
}
Opérations liées
- Mettre à jour, archiver ou restaurer un prompt.
- Mettre à jour des prompts en masse.
- Lister les prompts avec
view=configurationpour récupérer les champs modifiables et les prompts archivés.
Erreurs
Des champs invalides renvoient400 INVALID_REQUEST ; des identifiants de workspace ou de libellé inaccessibles renvoient 404 RESOURCE_NOT_FOUND. Un texte en doublon, y compris celui d’un prompt archivé, renvoie 409 CONFLICT ; restaurez le prompt archivé au lieu de le recréer.
Consultez Codes d’erreur pour les erreurs d’authentification, d’offre, d’idempotence et de serveur. Sur 429, respectez Retry-After ; les écritures peuvent renvoyer 503 SERVICE_UNAVAILABLE si le limiteur d’écriture est indisponible.
