Skip to content

Create a video task ​

POST /v1/videos

Create one asynchronous task. Fixed per-video billing; failed tasks are refunded. Do not re-submit after a client timeout without checking the existing task.

Guide and limits

Try this endpoint ​

Enter your API key and request parameters, then send. Generation requests are billed normally; authentication is not persisted in your browser.

application/json ​

Conflicting aliases/metadata are rejected. Single-image and reference-image inputs are mutually exclusive. For reference mode use fast/pro and 3–10 seconds.

NameTypeRequiredDefault / valuesDescription
modelstringyescogvideo-fast, cogvideo-pro, cogvideo-basic, cogvideo-short
promptstringyes—Non-blank prompt, at most 4096 Unicode characters.
secondsinteger / stringno—Defaults: fast/pro/basic=5; short=8. Basic maximum 5; reference mode minimum 3; short exactly 8.
durationinteger / stringno—Defaults: fast/pro/basic=5; short=8. Basic maximum 5; reference mode minimum 3; short exactly 8.
sizestringno1920x1080, 1080x1920, 1080x1080, 1440x1080, 1080x1440, 720x1280fast/pro/basic: 1080p sizes only; short: 720x1280 only. Actual encoding dimensions are read from the file.
resolutionstringno1080p, 720p
aspect_ratiostringno16:9, 9:16, 1:1, 4:3, 3:4
input_referencestringno—HTTP(S) image URL or Base64 image data URL.
image_urlstringno—HTTP(S) image URL or Base64 image data URL.
reference_imagesarrayno—
generation_modestringnospeed, pro, pro_ad
metadataobjectno—
nintegerno1
sample_countintegerno1

Example request ​

json
{
  "model": "cogvideo-fast",
  "prompt": "红色纸船在平静的池塘上缓缓漂浮",
  "seconds": "5",
  "size": "1920x1080"
}

multipart/form-data ​

NameTypeRequiredDefault / valuesDescription
modelstringyescogvideo-fast, cogvideo-pro, cogvideo-basic, cogvideo-short
promptstringyes—Non-blank prompt, at most 4096 Unicode characters.
secondsinteger / stringno—Defaults: fast/pro/basic=5; short=8. Basic maximum 5; reference mode minimum 3; short exactly 8.
durationinteger / stringno—Defaults: fast/pro/basic=5; short=8. Basic maximum 5; reference mode minimum 3; short exactly 8.
sizestringno1920x1080, 1080x1920, 1080x1080, 1440x1080, 1080x1440, 720x1280fast/pro/basic: 1080p sizes only; short: 720x1280 only. Actual encoding dimensions are read from the file.
resolutionstringno1080p, 720p
aspect_ratiostringno16:9, 9:16, 1:1, 4:3, 3:4
input_referencestringno—At most one image file, 20 MiB maximum.
image_urlstringno—HTTP(S) image URL or Base64 image data URL.
reference_imagesarrayno—
generation_modestringnospeed, pro, pro_ad
nintegerno1
sample_countintegerno1
metadatastringno—JSON-encoded metadata object.

Responses ​

StatusDescription
200Task accepted. Save id and poll; task status determines eventual success.
400Unsupported or conflicting parameters.
401Missing or invalid customer API Key.
429Capacity or rate limit exceeded.

application/json ​

json
{
  "id": "task_EXAMPLE",
  "object": "video",
  "status": "queued",
  "progress": 0,
  "created_at": 1790980000
}