Skip to main content
POST
Create a Pitch Audit
Creates a Pitch Audit for the agency team attached to the API key and queues prompt preparation. Use the default review flow, or explicitly enable automatic answer collection.
Requires an agency team on an active Business, Agency Business, or Enterprise plan. Existing API keys work without rotation.
string
required
Bearer token. Example: Bearer qw-api-xxx
string
required
Unique key for this audit. Replaying the same request returns the original response instead of creating another audit.
string
required
Prospect website URL or domain, up to 2048 characters.
string
Prospect display name, up to 120 characters. Defaults to the normalized domain.
string
default:"US"
Supported two-letter market code. The market controls model availability.
number
default:"30"
Number of prompts to prepare, from 20 to 100. With customPrompts, omit it or send the number of imported prompts.
array
From 20 to 100 distinct prompt texts to import instead of generating a prompt set.
array
Models to use. Omit to use the Pitch Audit defaults available in the selected market.
boolean
default:"false"
Set to true to start billable answer collection after prompt preparation. Keep false to review and save the prompts before confirmation.

Response

Returns 202 with a Location header pointing to GET /api/v1/pitch-audits/{auditId}.
string
Opaque Pitch Audit identifier.
string
URL of the report resource.
number
Credits required by the selected prompt and model configuration.
number
Team balance observed when the audit was accepted.
string
QUEUED when dispatch succeeded, or RECOVERING when the durable recovery path will retry it.

Synthetic request

Next step

Poll Get Pitch Audit. When it reaches AWAITING_PROMPTS, review the returned prompts and save them with the response ETag, then confirm the audit.

Errors