Livestreams

Retrieve Livestream

Changed on

Retrieves a livestream by ID.

get/livestreams/{id}

Request

  • Base URL
    https://api.whop.com/api/v1
  • URL
    https://api.whop.com/api/v1/livestreams/{id}
  • Auth
    HTTP bearer

Response

livestream found

created_atstring required

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

ended_atstring nullable required

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

idstring required

Livestream ID, prefixed lfeed_.

pinned_atstring nullable required

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

recording_started_atstring nullable 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.

recording_status'recording' | 'processing' | 'completed' | 'failed' | 'null' nullable required

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

recording_urlstring nullable 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.

started_atstring nullable required

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

thumbnail_urlstring nullable required

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

titlestring required

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

Example response

{
  "created_at": "2026-01-01T12:00:00.000Z",
  "ended_at": "2026-01-01T12:00:00.000Z",
  "id": "lfeed_xxxxxxxxxxxxxxxxxxxxxx",
  "pinned_at": "2026-01-01T12:00:00.000Z",
  "recording_started_at": "2026-01-01T12:00:00.000Z",
  "recording_status": "completed",
  "recording_url": "https://whop-livestreams-example.s3.amazonaws.com/room/lfeed_xxxxxxxxxxxxxxxxxxxxxx.mp4",
  "started_at": "2026-01-01T12:00:00.000Z",
  "thumbnail_url": "https://img.whop.com/livestreams/lfeed_xxxxxxxxxxxxxxxxxxxxxx.jpg",
  "title": "Live edit: blue hour"
}

Changes