/api/v1/videosReturns 202 Accepted with a public video generation response. Unknown body fields such as routing, metadata, webhook_url, priority, or idempotency fields are rejected.
Back to Videos endpoint listRequest parameters
FieldTypeRequiredDescription
modelstringyesVideo model ID, for example dreamina-seedance-2-0-260128.promptstringyesText prompt for the video generation.aspect_ratiostringnoSupported aspect ratio such as 16:9, 9:16, or 1:1. Do not send with size.callback_urlstringnoHTTPS URI for completion notifications, max 1000 characters.durationintegernoRequested video length in seconds, >= 1.frame_imagesobject[]noFirst-frame or last-frame image inputs.frame_images[].typestringyesMust be image_url for each frame image item.frame_images[].image_url.urlstringyesRemote image URL for the first or last frame.frame_images[].frame_typestringyesFrame placement, either first_frame or last_frame.generate_audiobooleannoWhether audio should be generated when supported.input_referencesobject[]noReference image, audio, or video inputs.input_references[].typestringyesReference kind: image_url, audio_url, or video_url.input_references[].image_url.urlstringconditionalRemote image URL when type is image_url.input_references[].audio_url.urlstringconditionalRemote audio URL when type is audio_url.input_references[].video_url.urlstringconditionalRemote video URL when type is video_url.provider.provider_idstringnoProvider ID used to route the request, for example byteplus.provider.optionsobjectnoProvider-keyed options, for example { byteplus: { ... } }.resolutionstringnoSupported resolution such as 480p, 720p, or 1080p. Do not send with size.srobjectnoVideo super resolution configuration. Only this endpoint supports SR, and only sr.resolution is accepted.sr.resolutionstringnoTarget SR resolution: 720p, 1080p (default), 1440p, 2160p, or 4k. The service preserves the original aspect ratio and maps this value to the LAS target width.seedintegernoDeterministic seed when supported by the model.sizestringnoAllowed values: 480x480, 480x640, 480x720, 480x854, 480x1120, 640x480, 720x480, 720x720, 720x960, 720x1080, 720x1280, 720x1680, 854x480, 960x720, 1080x720, 1080x1080, 1080x1440, 1080x1620, 1080x1920, 1080x2520, 1120x480, 1280x720, 1440x1080, 1620x1080, 1680x720, 1920x1080, 2160x2160, 2160x2880, 2160x3240, 2160x3840, 2160x5040, 2520x1080, 2880x2160, 3240x2160, 3840x2160, 5040x2160. Use either size or resolution/aspect_ratio, not both.Response fields
FieldTypeRequiredDescription
idstringyesGlobalRouter video generation job ID.polling_urlstringyesRelative URL for polling the job.statusstringyespending, in_progress, completed, failed, cancelled, or expired.errorstringnoFailure message when available.generation_idstringnoUpstream provider generation ID when available.unsigned_urlsstring[]noGlobalRouter artifact URLs for completed jobs.usageobjectnoUsage summary with cost and optional BYOK status.usage.video_generation_cost_cnynumbernoCNY cost for the original video generation when SR is requested.usage.sr_cost_cnynumbernoCNY cost for video super resolution when SR is requested.Notes
- Use callback_url for completion notifications. Download completed artifacts from GET /api/v1/videos/{jobId}/content.
- Request examples use provider as a string; provider object is reserved for advanced provider-specific options.
- Example scenarios: text-to-video, image-first-frame, reference-material.
- Use either size or resolution/aspect_ratio, not both.
- Inside sr, only resolution is accepted. provider, mode, and other extra properties are rejected.
- With SR, the response exposes one final video: the enhanced video on success or the original video when SR fails.