Skip to main content
POST
Create a pitch report

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Headers

Idempotency-Key
string
required

Stable identifier for one logical request. Preserve it on retries.

Required string length: 1 - 128

Body

application/json
website_url
string
required
Maximum string length: 2000
Example:

"https://example.com"

country
string
default:United States
Maximum string length: 100
language
string
default:English
Maximum string length: 100

Response

Accepted, or the existing result for an idempotent retry. Generation may take several minutes.

pitch_id
string<uuid>
required
status
enum<string>
required
Available options:
processing,
completed,
failed
report_url
string<uri>
required