Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended).

Query Parameters

milestone
enum<string>
default:transcribed

Hydration milestone to stream. Episodes are delivered once they reach this stage. Milestones are ordered discovered < transcribed < segmented < fully_ingested.

Available options:
discovered,
transcribed,
segmented,
fully_ingested
cursor
string

Opaque cursor from a prior event envelope. When supplied, the stream replays everything after it then continues live.

since
string

ISO 8601 date or date-time to backfill from when no cursor is supplied. Ignored if cursor is set.

include
enum<string>[] | null

Heavy relations to embed in each episode (comma-separated). transcript is the dialogue transcript; segments and clips are the AI-derived sets; all means everything available at the chosen milestone. A field is only valid when its data is guaranteed at the milestone (transcript→transcribed, segments→segmented, clips→fully_ingested); requesting one earlier is a terminal error.

Available options:
transcript,
segments,
clips,
all

Body

application/json
podcast_ids
string[] | null

Filter to a set of podcasts by slug or ID. An episode is delivered if its podcast matches any of them. Unknown values are ignored; if none match you receive a terminal error rather than the full firehose.

popularity_threshold
number<double>

Filter to podcasts whose popularity percentile is at least this value, in (0,1). Omit (or 0) for no popularity filter. Popularity is normalized 0–1 across the catalog, so 0.9 ≈ the top 10%. Combines with podcast_ids as a union.

Required range: x >= 0

Response

OK

data
object
required
event
string
required

The event name.

Allowed value: "episode"
id
integer

The event ID.

retry
integer

The retry time in milliseconds.