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

Changes

Changed in 3 of the 9 revisions of this API.910

Oct 30, 2025dfc937fc0d2c63See the full diff
- ▲
  the oneOf[subschema #1: HTTPError]/detail response's property type/format changed from object/ to / for status 400
  response-property-type-changed
- ▲
  the oneOf[subschema #1: HTTPError]/detail response's property type/format changed from object/ to / for status 401
  response-property-type-changed
- ▲
  the oneOf[subschema #1: HTTPError]/detail response's property type/format changed from object/ to / for status 500
  response-property-type-changed
- ▲
  removed the required property oneOf[subschema #1: HTTPError]/detail/msg from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property oneOf[subschema #1: HTTPError]/detail/msg from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property oneOf[subschema #1: HTTPError]/detail/msg from the response with the 500 status
  response-required-property-removed
- ○
  added APIError to the oneOf[subschema #1: HTTPError]/detail response property allOf list for the response status 400
  response-property-all-of-added
- ○
  added APIError to the oneOf[subschema #1: HTTPError]/detail response property allOf list for the response status 401
  response-property-all-of-added
- ○
  added APIError to the oneOf[subschema #1: HTTPError]/detail response property allOf list for the response status 500
  response-property-all-of-added
Oct 30, 2025f5d01b71ba9a36See the full diff
- ▲
  the oneOf[subschema #1: HTTPError]/detail response's property type/format changed from / to object/ for status 400
  response-property-type-changed
- ▲
  the oneOf[subschema #1: HTTPError]/detail response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the oneOf[subschema #1: HTTPError]/detail response's property type/format changed from / to object/ for status 500
  response-property-type-changed
- ○
  removed APIError from the oneOf[subschema #1: HTTPError]/detail response property allOf list for the response status 400
  response-property-all-of-removed
- ○
  removed APIError from the oneOf[subschema #1: HTTPError]/detail response property allOf list for the response status 401
  response-property-all-of-removed
- ○
  removed APIError from the oneOf[subschema #1: HTTPError]/detail response property allOf list for the response status 500
  response-property-all-of-removed
- ○
  added the required property oneOf[subschema #1: HTTPError]/detail/msg to the response with the 400 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #1: HTTPError]/detail/msg to the response with the 401 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #1: HTTPError]/detail/msg to the response with the 500 status
  response-required-property-added
Oct 28, 2025dfc937fc0d2c1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history