API documentation

Getting started

Once the API is live, getting started will look like this:

1. Sign up on the pricing page and pick a tier. Free will be enough to evaluate every Tier 1 endpoint.
2. Copy your API key from the dashboard. Keys start with sa_live_ and are shown once at creation — store them somewhere safe.
3. Make your first call:

# 30-second example: canonical IR page URL for AAPL
export SPOKEN_ALPHA_API_KEY="sk_live_..."
curl "https://api.spokenalpha.com/v1/companies/AAPL/ir-page" \
  -H "Authorization: Bearer $SPOKEN_ALPHA_API_KEY"

The response is a JSON object with the canonical IR URL, the call date, fiscal period, and (on paid tiers) confidence and detected sections. From here you can fetch a full transcript directly from the IR URL or, on Startup and above, parse it with POST /transcripts/{call_id}/parse.

Authentication

All requests must carry an Authorization: Bearer <key> header. Keys are scoped to a single account and tier; treat them like passwords. The Spoken Alpha API does not support session cookies, OAuth flows, or basic auth.

Errors

All non-2xx responses return JSON with error, code, and request_id fields. Quote the request_id when contacting support.

Changelog

Material changes to the API and SDK ship here. Breaking changes get a new major version (/v2) and never land in /v1.