v9

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-30102943.3 KB

generate

Live Video To Video

Apply transformations to a live video streamed to the returned endpoints.

post/api/generate/live-video-to-video

Request body

subscribe_urlstring required

Source URL of the incoming stream to subscribe to.

publish_urlstring required

Destination URL of the outgoing stream to publish.

control_urlstring

URL for subscribing via Trickle protocol for updates in the live video-to-video generation params.

events_urlstring

URL for publishing events via Trickle protocol for pipeline status and logs.

model_idstring required

Name of the pipeline to run in the live video to video job. Notice that this is named model_id for consistency with other routes, but it does not refer to a Hugging Face model ID. The exact model(s) depends on the pipeline implementation and might be configurable via the params argument.

paramsobject

Initial parameters for the pipeline.

gateway_request_idstring

The ID of the Gateway request (for logging purposes).

manifest_idstring

The manifest ID from the orchestrator (for logging purposes).

stream_idstring

The Stream ID (for logging purposes).

Response

Successful Response

subscribe_urlstring required

Source URL of the incoming stream to subscribe to

publish_urlstring required

Destination URL of the outgoing stream to publish to

control_urlstring

URL for updating the live video-to-video generation

events_urlstring

URL for subscribing to events for pipeline status and logs

request_idstring

The ID generated for this request

manifest_idstring

Orchestrator manifest ID for this request