BOboson
Videos

Create a video (streaming)

Changed on

Same request body as POST /v1/videos, but the response body IS the live fragmented-MP4 (fMP4) byte stream — frames arrive as they are generated, so playback can start before the clip is complete. The video id rides back in the X-Video-Id header; the full MP4 is stored too, so a later GET /v1/videos/{video_id}/content works.

post/v1/videos/stream

Request

  • Base URL
    https://api.boson.ai
  • URL
    https://api.boson.ai/v1/videos/stream
  • Auth
    HTTP bearer

Request body

model'higgs-avatar'

Avatar model ID / public alias.

ref_imagestring required

Reference image (the face to animate): an http(s) URL, data URI, or base64-encoded raw image bytes. Supported formats: PNG, JPEG, WEBP. Inline (base64 / data-URI) payloads: max 10 MB.

inputstring nullable

Audio-to-video: the driving speech audio as an http(s) URL, data URI, or base64-encoded raw audio bytes. Supported formats: AAC, WAV, MP3, FLAC, OPUS. Max duration: 60 s (it sets the output video length). Provide exactly one of input / input_tts.

size'640x640' | '640x480' | '480x640'

Output video size (WxH): square 640x640, landscape 640x480, or portrait 480x640.

Example request

{
  "input_tts": {
    "input": "Hello, this is a test."
  }
}

Response

The fragmented-MP4 (fMP4) byte stream.

Changes

  • 68bf7c248c4cRevision changes
    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      the ///// request property's maxLength was increased from 5000 to 50000

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status