v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
Agentic Videos

Create an agentic video

Create a new agentic video from a source video. Returns immediately with the video_id; processing and agent creation happen asynchronously, so poll GET /agentic-videos/{video_id} and watch status until it reaches done.

post/agentic-videos

Request body

source_urlstring required

URL of the source video to turn into an agentic video. Accepts either:

  • a direct file URL (.mp4, .mov, .mpeg) reachable over https://, or
  • a YouTube video URL (watch, shorts, youtu.be, embed, or live links).

Uploaded/direct-file videos may be up to 20 minutes long

namestring

Display name for the agentic video. If omitted, a name is derived from the source (the YouTube title or the file name).

presenter_idstring required

ID of the presenter that fronts the agent in the chat experience. Must be an expressive avatar.

bubble_textstring

Text shown in the call-to-action bubble that invites viewers to start chatting.

knowledgestring

Optional knowledge base text the agent uses to answer viewer questions. Applies to YouTube sources; for uploaded videos the knowledge is derived automatically from the video's transcript.

show_agent_on_video_endboolean

Whether the agent automatically appears when the video finishes playing.

Example request

{
  "source_url": "https://path.to.directory/movie.mp4",
  "background": {
    "color": "#47ffff",
    "source_url": "https://path.to.image/"
  }
}

Response

Agentic video created

video_idstring required

Unique identifier of the created agentic video. Use it with the other /agentic-videos/{video_id} endpoints.

status'created' | 'started' | 'ready' | 'done' | 'error' required

Processing status of an agentic video.

  • created — the video was accepted and is queued for processing.
  • started — the video is being processed.
  • ready — the agent has been created and is initializing.
  • done — the agent is active and the agentic video is fully available to viewers.
  • error — processing failed; see the error field for details.