API Reference
Start typing to search…

Create with Video Agent

post
https://api.heygen.com/v1/video_agent/generate

Generate a video with a one-shot prompt.

Body Params
string
required

Prompt provided to Video Agent. Refer to our Prompt Guide for best practices.

config
object

Optional configurations for the video, including setting a specific avatar for the video.

files
array of objects

List of assets that Video Agent can reference.

files
string

Custom ID for callback and webhook purposes. Returned in the status payload for tracking.

string

URL to notify when video rendering is complete, useful when your callback endpoint is dynamic and each video requires a separate callback. Using a webhook endpoint is still the recommended approach, as it provides more customization options such as secrets, event filtering, and more. If both webhook and callback_url are used, events will be sent to both endpoints.

Response

Updated 26 days ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 26 days ago