Skip to main content
GET
Retrieve Livestream

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Path Parameters

id
string
required

Livestream ID, prefixed lfeed_.

Response

livestream found

created_at
string
required

When the livestream was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

ended_at
string | null
required

When the livestream ended, as an ISO 8601 timestamp. null while it is live or before it starts.

Example:

"2026-01-01T12:00:00.000Z"

id
string
required

Livestream ID, prefixed lfeed_.

Example:

"lfeed_xxxxxxxxxxxxxxxxxxxxxx"

pinned_at
string | null
required

When a moderator pinned this livestream's recording, as an ISO 8601 timestamp. null when it is not pinned.

Example:

"2026-01-01T12:00:00.000Z"

recording_started_at
string | null
required

When the recording's first frame was captured, as an ISO 8601 timestamp. Offsets into the recording count from here, not from started_at. null until recording starts.

Example:

"2026-01-01T12:00:00.000Z"

recording_status
enum<string> | null
required

State of the recording. null when the livestream was not recorded.

Available options:
recording,
processing,
completed,
failed,
null
Example:

"completed"

recording_url
string | null
required

A temporary link to the recording's video file. Retrieve the livestream again for a fresh link. null until the recording is ready, or when it was deleted.

Example:

"https://whop-livestreams-example.s3.amazonaws.com/room/lfeed_xxxxxxxxxxxxxxxxxxxxxx.mp4"

started_at
string | null
required

When the livestream went live, as an ISO 8601 timestamp. null before it starts.

Example:

"2026-01-01T12:00:00.000Z"

thumbnail_url
string | null
required

A temporary link to a still frame from the livestream. null when none was captured.

Example:

"https://img.whop.com/livestreams/lfeed_xxxxxxxxxxxxxxxxxxxxxx.jpg"

title
string
required

Display title of the livestream. Untitled Livestream when the host did not set one.

Example:

"Live edit: blue hour"