ATathenahq
Pitch Workspace

Create a pitch report

Changed on

Generate a Pitch Workspace report from a public website URL. Requires a global organization API key, Pitch Workspace entitlement, and available pitch allowance. Returns a durable pitch ID while research runs. Poll GET /api/v1/pitches/{pitch_id} until pitch.status is completed or failed. The report URL is accessible to anyone holding it. Each admitted request consumes one pitch, including attempts that fail during generation. Retrying the same organization and Idempotency-Key with the same normalized input reuses the pitch; different input returns 409. Use a new key to deliberately request a fresh snapshot. Generation does not send email.

post/api/v1/pitches

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

Headers

Idempotency-Keystring required

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

Request body

website_urlstring required
countrystring
languagestring

Example request

{
  "website_url": "https://example.com"
}

Response

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

pitch_idstring uuid required
status'processing' | 'completed' | 'failed' required
report_urlstring uri required

Changes