- Authentication and API keys
- Balance and billing
- Video generation
- Troubleshooting and errors
- Files and assets
- Error reference
Authentication and API keys
How do I get an API key?
How do I get an API key?
What is the base URL and how do I authenticate?
What is the base URL and how do I authenticate?
Authorization header to every request:My API key stopped working. What should I check?
My API key stopped working. What should I check?
- Confirm the key has not been revoked in the API Keys area of the Dashboard.
- Send the key as
Authorization: Bearer <key>, not as a query parameter. - Confirm that the key has not expired.
- Check that the workspace has enough available balance for the request.
Balance and billing
How do I check my current balance?
How do I check my current balance?
How is usage charged?
How is usage charged?
What happens when my available balance is insufficient?
What happens when my available balance is insufficient?
Video generation
Video generation is asynchronous. How does polling work?
Video generation is asynchronous. How does polling work?
POST /contents/generations/tasks. The response contains an id. Poll GET /contents/generations/tasks/{id} until status is succeeded, failed, cancelled, or another documented terminal value.A polling interval of three to five seconds is a reasonable starting point.How long does video generation take?
How long does video generation take?
What generation modes are supported?
What generation modes are supported?
text_to_video: generate from a text prompt.image_first_frame: use an image as the starting frame.image_first_last_frame: provide both starting and ending frames.multimodal_reference: guide generation with reference images, videos, or audio.video_modify: edit an existing video.video_extend: extend an existing video.
What resolutions and durations are supported?
What resolutions and durations are supported?
480p, 720p, 1080p, and 4k; durations and supported aspect ratios also differ.Check the selected model before sending the request. The Seedance 2.0 Fast variant, for example, does not support 1080p or 4k.My task is stuck in processing. What should I do?
My task is stuck in processing. What should I do?
My task failed content moderation. What can I do?
My task failed content moderation. What can I do?
- Prompt text involving restricted, sensitive, or protected content.
- A reference image or video with a recognizable face that was not prepared through the required Asset Group workflow.
- Generated output rejected by provider post-generation checks.
Troubleshooting and errors
The input image may contain a real person
The input image may contain a real person
Active, and generate with its asset:// URI. See Generate videos with face assets.The output audio may contain sensitive information
The output audio may contain sensitive information
controls.generateAudio, then submit the generation request again.What are the rate limits?
What are the rate limits?
I am receiving 429 responses. What should I do?
I am receiving 429 responses. What should I do?
- Use exponential backoff with jitter.
- Reduce concurrent in-flight requests.
- Inspect the returned machine-readable error code to determine which limit was reached.
- Do not retry in a tight loop.
I am receiving 401 responses. What should I do?
I am receiving 401 responses. What should I do?
- Verify that the key is complete and has not been revoked.
- Format the header as
Authorization: Bearer <key>. - Make sure server code is loading the intended environment variable.
- Do not send the key as a URL query parameter.
I received an error that is not listed here. What should I do?
I received an error that is not listed here. What should I do?
Files and assets
What is the difference between Files and Asset Groups?
What is the difference between Files and Asset Groups?
asset:// URI or when related assets should remain organized together.What media formats can I use?
What media formats can I use?
- Images: JPEG, PNG, and WebP.
- Videos: MP4 and MOV with supported codecs.
- Audio: MP3, WAV, and AAC.
How do I use a real person's photo to generate videos?
How do I use a real person's photo to generate videos?
Active preprocessing status, and asset://<ASSET_ID> request values.Start with Generate videos with face assets.When the subject needs to provide explicit authorization, create a Real-Person Verification Session, direct the subject to the returned H5 URL, and then retrieve the verification result.An uploaded asset is still processing. Is it ready to use?
An uploaded asset is still processing. Is it ready to use?
Result.Status is Active. Preprocessing often completes quickly, but clients must use the returned status rather than assume readiness after a fixed delay.