Passer au contenu principal
POST
Créer un audit de prospection
Crée un audit de prospection pour l’équipe agence liée à la clé d’API et met en file la préparation des prompts. Utilisez le parcours de relecture par défaut, ou activez explicitement la collecte automatique des réponses.
Nécessite une équipe agence sur une offre Business, Agency Business ou Enterprise active. Les clés d’API existantes fonctionnent sans rotation.
string
requis
Jeton bearer. Exemple : Bearer qw-api-xxx
string
requis
Clé unique pour cet audit. Rejouer la même requête renvoie la réponse d’origine au lieu de créer un autre audit.
string
requis
URL ou domaine du site du prospect, 2048 caractères au maximum.
string
Nom affiché du prospect, 120 caractères au maximum. Par défaut, le domaine normalisé.
string
défaut:"US"
Code de marché pris en charge sur deux lettres. Le marché détermine la disponibilité des modèles.
number
défaut:"30"
Nombre de prompts à préparer, de 20 à 100. Avec customPrompts, omettez-le ou envoyez le nombre de prompts importés.
array
De 20 à 100 textes de prompts distincts à importer au lieu de générer un ensemble de prompts.
array
Modèles à utiliser. Omettez-le pour utiliser les modèles par défaut de l’audit de prospection disponibles sur le marché sélectionné.
boolean
défaut:"false"
Définissez true pour lancer la collecte de réponses facturable après la préparation des prompts. Gardez false pour relire et enregistrer les prompts avant la confirmation.

Réponse

Renvoie 202 avec un en-tête Location pointant vers GET /api/v1/pitch-audits/{auditId}.
string
Identifiant opaque de l’audit de prospection.
string
URL de la ressource du rapport.
number
Crédits requis par la configuration de prompts et de modèles sélectionnée.
number
Solde de l’équipe observé à l’acceptation de l’audit.
string
QUEUED lorsque l’envoi a réussi, ou RECOVERING lorsque le mécanisme de reprise durable le retentera.

Requête synthétique

Étape suivante

Interrogez Obtenir un audit de prospection. Lorsqu’il atteint AWAITING_PROMPTS, relisez les prompts renvoyés et enregistrez-les avec l’ETag de la réponse, puis confirmez l’audit.

Erreurs