v1

latestOpenAPI 3.1.02026-07-2671117149.2 KB

Apis

Streaming

Create Stream

Create a live stream: ingest a source, process it with one or more AI pipelines, and publish the results to one or more targets.

post/stream

Request body

namestring nullable

Display name for the stream. Auto-generated if omitted.

descriptionstring nullable

Free-form description of the stream.

initial_delayinteger

Seconds of setup lead time before processing starts. Larger values give the pipeline more headroom to warm up; smaller values start output sooner.

voicesinteger[]

Optional voice IDs from GET /list-voices to use for dubbed speech. If provided, these fixed voices are used; if omitted or empty, voices are cloned from the speakers in the source audio. When providing voices, include different genders and tones so each speaker can be matched to the most suitable voice.

dictionariesinteger[]

Optional dictionary IDs for custom terminology (up to 5), from GET /dictionaries.

start_timestring date-time nullable

Optional scheduled start in ISO 8601 with a UTC offset, e.g. 2026-08-01T19:30:00Z. If omitted, the stream starts as soon as it is created. Cannot be in the past; at most 7 days in the future.

end_timestring date-time required

When the stream stops, in ISO 8601 with a UTC offset. Required; must be at least 15 minutes after the start. To end a stream earlier, delete it; to change the end, patch it.

timezonestring required

IANA time zone name (e.g. UTC, Europe/London) that start_time/end_time are expressed in. Its offset must match the timestamps.

Response

Successful Response

stream_idinteger

Identifier of the created stream, used for all lifecycle operations.

task_idstring

Identifier of the setup task; useful when contacting support.