Skip to main content
POST
Add Livestream Co-host

Yetkilendirmeler

Authorization
string
header
gerekli

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.

Scopes

livestream:moderate

Başlıklar

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Örnek:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

Livestream ID, prefixed lfeed_.

Gövde

application/json
user_id
string
gerekli

User ID, prefixed user_. The user needs access to the livestream.

Örnek:

"user_xxxxxxxxxxxxxx"

Yanıt

co-host added

created_at
string
gerekli

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

Örnek:

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

ended_at
string | null
gerekli

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

Örnek:

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

id
string
gerekli

Livestream ID, prefixed lfeed_.

Örnek:

"lfeed_xxxxxxxxxxxxxxxxxxxxxx"

pinned_at
string | null
gerekli

When the recording was pinned or last moved, as an ISO 8601 timestamp. Pinned livestreams are ordered by it, newest first. null when not pinned.

Örnek:

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

recording_started_at
string | null
gerekli

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.

Örnek:

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

recording_status
enum<string> | null
gerekli

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

Mevcut seçenekler:
recording,
processing,
completed,
failed,
null
Örnek:

"completed"

recording_url
string | null
gerekli

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.

Örnek:

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

started_at
string | null
gerekli

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

Örnek:

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

thumbnail_url
string | null
gerekli

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

Örnek:

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

title
string
gerekli

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

Örnek:

"Live edit: blue hour"

recap
object

Top moments AI picked from chat, and chat activity. Only retrieve returns it, and only to callers with the livestream:moderate permission.