Passer au contenu principal
POST
Lancer la collecte de réponses

Autorisations

x-api-key
string
header
requis

Clé API d’authentification. Créez-en une ici.

Corps

application/json
website_id
string<uuid>
requis

Site web pour lequel lancer la collecte de réponses en continu.

schedule_id
string<uuid>

UUID de planification auquel attribuer l’exécution et dont reprendre les sélecteurs. Une sélection prompt_ids non vide prévaut. Omettre attribue à Par défaut et lance tous les prompts actifs sauf prompt_ids fourni. Les choix explicites de modèles, expansion, personas et emplacements s’appliquent à cette exécution. La planification doit appartenir au site et ne pas être archivée.

prompt_ids
string<uuid>[]

UUID des prompts suivis à exécuter, de 1 à 1 000. Remplace les sélecteurs de prompts de la programmation si fourni. Omettez pour utiliser les sélecteurs de schedule_id ou tous les prompts actifs si schedule_id est également omis. Les prompts en pause sont ignorés.

selected_models
object

Correspondance entre ID de modèle et indicateur d’activation (ex. : { "ai_overview": true, "ai_mode": false }). ID de modèles : chatgpt, ai_overview (Google AI Overviews ; google_ai_overview, son nom dans les filtres de modèles, est également accepté), perplexity, gemini, copilot, ai_mode, grok, claude, deepseek, meta_ai, mistral. Omettez pour exécuter tous les modèles actuellement actifs — il ne s’agit pas de la sélection par défaut enregistrée dans le tableau de bord. Un ID défini sur true ne désignant aucun modèle est rejeté avec 400, tout comme une sélection explicite ne correspondant à aucun modèle disponible.

prompt_variations
integer

Nombre de variantes reformulées par prompt à générer (0–10).

Plage requise: 0 <= x <= 10
use_personas
boolean

Indique si les prompts doivent utiliser les personas configurés.

use_locations
boolean

Indique s’il faut exécuter les prompts sur les emplacements configurés du site.

only_locations
boolean

Si vrai, ignore l’exécution de base non localisée et exécute uniquement les variantes géographiques. Exige use_locations: true : only_locations: true sans use_locations: true ne met rien en file, car la base est ignorée et aucune variante ajoutée ; l’exécution termine sans action.

Réponse

Exécution démarrée

workflow_id
string
requis
status
enum<string>
requis
Options disponibles:
running