Create event

post

https://{hostname}/api/v1/streams/{stream_id}/events

Create a new event. Past-event artifacts are always produced by the async worker pipeline; ?async only controls whether the request waits for the worker to finish (sync response) or returns immediately (async response). A successful sync response omits the clipping field; async responses include it.

Path Params

stream_id

string

required

Stream ID.

Query Params

async

boolean

When ?async=true, returns immediately with the queued event (async response). Defaults to a synchronous response that waits for the worker. Ignored when force_non_blocking_creation is true in config (async is forced).

Body Params

end_time

date-time | null

Scheduled end time of the event.

event_name

string

required

Name of the event.

source_event_name

string | null

Source of the event.

start_time

date-time | null

Scheduled start time of the event.

subsegment_clipping

boolean | null

Controls whether subsegment clipping is enabled for this event.
When subsegment_clipping is set to true, the playlist will include an #EXT-X-START:TIME-OFFSET
tag so that the player begins playback at the start_time specified in the event creation request.
This allows playback to begin from a precise point, even if it does not align with a segment boundary.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Event created successfully (sync response: worker finished, or live event).

201Past event queued for the worker (async response).

400Invalid request.

401Unauthorized.

403Forbidden - no access to stream.

409Conflict.

412Precondition Failed.

500Internal server error.

503Past event worker is not available.