AI-TokenHub

English

简体中文

English

简体中文

Appearance

Request
Response

Query Video Generation Task API ​

Query the status of a video generation task.

Request Information ​

ItemValue
Request MethodGET
Request URLhttps://ai-tokenhub.com/api/v2/contents/generations/tasks/id
Content-Typeapplication/json
AuthenticationAPI Key Authentication (Bearer Token)

Request Headers ​

Field NameRequiredDescription
Authorization✓Format: Bearer <your_api_key>, same API key used for task creation
Content-Type✓Fixed value: application/json

Request Parameters ​

id string Required

The ID of the video generation task you want to query.

Note
The above parameter is a Query String Parameter, passed in the URL String.

Response Parameters ​

id string

Video generation task ID.

model string

The model name and version used for the task, model_name-version

status string

Task status and related information:

  • queued: Queued.
  • running: Task running.
  • cancelled: Task cancelled, cancelled status automatically deleted after 24h (only tasks in queued status can be cancelled).
  • succeeded: Task succeeded.
  • failed: Task failed.
  • expired: Task timed out.

error object / null

Error message, returns null if task succeeds, returns error data if task fails. For detailed error information, see Error Handling.

Properties:

  • error.code string Error code.

  • error.message string Error message.

created_at integer

Unix timestamp (seconds) when the task was created.

updated_at integer

Unix timestamp (seconds) when the task status was last updated.

content object
Output content of the video generation task.
Properties:

  • content.video_url string URL of the generated video, in mp4 format. Valid for 24 hours, please download or transfer in a timely manner. We recommend configuring the data subscription function provided by Volcengine TOS to automatically transfer your model inference output to your own TOS bucket for long-term backup or secondary processing. For detailed introduction, please refer to TOS Data Subscription.
  • content.last_frame_url string URL of the last frame image of the video. Valid for 24 hours, please download or transfer in a timely manner. Note: This parameter is returned when "return_last_frame": true is set when creating the video generation task.

seed integer
The seed integer value used for this request.

resolution string
Resolution of the generated video.

ratio string
Aspect ratio of the generated video.

duration integer
Duration of the generated video, in seconds.
Note: Only one of the duration and frames parameters will be returned. If frames is not specified when creating the video generation task, duration will be returned.

frames integer
Number of frames of the generated video.
Note: Only one of the duration and frames parameters will be returned. If frames is specified when creating the video generation task, frames will be returned.

framespersecond integer
Frame rate of the generated video.

generate_audio boolean
Whether the generated video contains synchronized audio with the video.

  • true: The video output by the model contains synchronized audio.
  • false: The video output by the model is silent.

tools object[] Tools actually used by the model for this request. Not returned if no tools were used.

Properties:

  • tools.type string

    The actual tool type used

    • web_search: Web search tool.

draft_task_id string
Draft video task ID. This parameter is returned when generating a formal video based on a Draft video.

service_tier string
Service tier actually used for processing the task.

execution_expires_after integer
Task timeout threshold, in seconds.

usage object
Token usage for this request.
Properties:

  • usage.completion_tokens integer
    Number of tokens consumed by the model for video generation, which can be used as the basis for billing reconciliation.

Note
The seedance 2.0 series models have a minimum token usage limit. If the actual token usage is less than the minimum token usage, this field will return the minimum token usage, and the platform will charge according to the minimum token usage.

usage.total_tokens integer
Total number of tokens consumed for this request. Video generation models do not count input tokens (input tokens = 0), so total_tokens=completion_tokens.