Skip to main content
POST
/
v1
/
videos
/
generations
curl --request POST \
  --url https://api.foxapi.cc/v1/videos/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "model": "heygen-video-agent",
  "prompt": "A weather reporter in front of a sunny city skyline introducing today's forecast in an upbeat tone."
}
EOF
{
  "created": 1757165031,
  "id": "task-unified-1757165031-uyujaw3d",
  "model": "<string>",
  "object": "video.generation.task",
  "progress": 0,
  "status": "pending",
  "task_info": {
    "can_cancel": true,
    "estimated_time": 45
  },
  "type": "video"
}

Documentation Index

Fetch the complete documentation index at: https://docs.foxapi.cc/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

All endpoints require Bearer Token authentication

Add the following header to your request:

Authorization: Bearer YOUR_API_KEY

Body

application/json
​
model
string
default:heygen-video-agent
required

heygen-video-agent: intelligent video agent that automatically generates digital avatar videos

Example:

"heygen-video-agent"

​
prompt
string
required

Natural language prompt describing the desired video content

Notes:

  • Maximum 10,000 characters
  • Video Agent autonomously decides casting, scripting, scene arrangement, and editing
  • Output video duration is determined by the model; clients cannot specify it
Maximum string length: 10000
Example:

"A weather reporter in front of a sunny city skyline introducing today's forecast."

​
avatar_id
string | null

HeyGen avatar identifier to use

Notes:

  • Omit or leave empty → Video Agent auto-selects
  • You can pass a HeyGen official avatar ID, or auto to let the model decide
Example:

"Anna_public_3_20240108"

​
voice_id
string | null

HeyGen voice identifier to use

Notes:

  • Omit or leave empty → Video Agent auto-selects
  • You can pass a HeyGen official voice ID, or auto to let the model decide
Example:

"en-US-Studio-O"

​
style_id
string | null

HeyGen visual style template ID

Notes:

  • Controls scene composition, pacing, and aesthetics
  • Omit to use the default style
Example:

"modern_vlog_01"

​
orientation
enum<string> | null

Output video orientation

Options:

  • landscape — horizontal
  • portrait — vertical
  • Omit → Video Agent decides automatically
Available options:
landscape,
portrait
Example:

"landscape"

​
file_urls
string[] | null

List of reference material URLs (images / videos / audio / PDFs)

Notes:

  • Up to 20 URLs

Do not pass this parameter unless necessary.

Example:
["https://example.com/screenshot-1.png"]
​
incognito_mode
boolean | null

Whether to enable incognito mode (disable agent memory)

Do not pass this parameter unless necessary.

Example:

true

Response

Task created successfully

​
created
integer

Task creation timestamp

Example:

1757165031

​
id
string

Task ID

Example:

"task-unified-1757165031-uyujaw3d"

​
model
string

Model name actually used

​
object
enum<string>

Specific type of the task

Available options:
video.generation.task
​
progress
integer

Task progress percentage (0-100)

Required range: 0 <= x <= 100
Example:

0

​
status
enum<string>

Task status

Available options:
pending,
processing,
completed,
failed
Example:

"pending"

​
task_info
object

Async task information

​
type
enum<string>

Output type of the task

Available options:
video
Example:

"video"