Task Management
⠀GET https://api.vidu.com/ent/v2/tasks
Field | Value | Description |
|---|---|---|
Content-Type | application/json | Data Exchange Format |
Authorization | Token \{your api key\} | Replace \{\} with your API key |
Field | Type | Required | Description |
|---|---|---|---|
created_at.from | String | Optional | Start time for querying task list, default is 7 days |
created_at.to | String | Optional | End time for querying task list, default is 7 days |
task_ids | Array | Optional | List of task IDs to be queried |
templates | Array | Optional | List of templates to be queried |
model_versions | Array | Optional | Model version to be queried，enum：2.0、q1、q2、q2-pro、q2-pro-fast |
resolutions | Array | Optional | Resolution to be queried |
states | Array | Optional | states to be queried，default is all，enum： - created - processing - queueing - success - failed |
pager.page | Int | Optional | Page number; starts from 0, default to 0 |
pager.pagesz | Int | Optional | Number of items per page; default to 10, max to 100 |
pager.page_token | String | Optional | Page token for pagination |
Field | Sub-field | Type | Description |
|---|---|---|---|
next_page_token | String | Page token for pagination | |
tasks | Array | Task list | |
id | String | Task id | |
key_id | String | Key_id used when creating tasks | |
template | String | Template enumeration values used for this task (returned only when type=template) | |
model | String | The model used for this call | |
prompt | String | The prompt words used in this call | |
images | Array | The images used in this task | |
duration | Int | The duration of this task | |
resolution | String | The resolution of this task | |
aspect_ratio | String | The aspect_ratio of this task | |
creations | object | Generated results | |
creations.id | String | Creation id | |
creations.url | String | The URL of the generated results, valid for 24 hours | |
creations.cover_url | String | The cover URL of the generated results, valid for 24 hours | |
creations.video | object | Video results | |
creations.video.duration | Float | The duration of this video | |
creations.video.fps | Int | The frame rate of this video | |
creations.video.resolution | object | The resolution of this video | |
creations.video.resolution.width | Int | The width of this video (px) | |
creations.video.resolution.height | Int | The height of this video (px) | |
state | String | It will be returned to a specific processing state: - created created task successfully - queueing task in queue - processing processing - success generation successful - failed task failed | |
created_at | String | Task creation time | |
credits | Int | The number of credits consumed by this task. Unit: credits. |
{ "next_page_token": "string", "tasks": [ { "id": "string", "key_id": "string", "type": "unspecified", "template": "string", "model": "string", "prompt": "string", "images": [ "string" ], "duration": 0, "resolution": "string", "aspect_ratio": "string", "state": "created", "creations": [ { "id": "string", "url": "string", "cover_url": "string", "watermarked_url": "string", "moderation_url": [ "string" ], "video": { "duration": 0, "fps": 0, "resolution": { "width": 0, "height": 0 } } } ], "created_at": "2019-08-24T14:15:22Z", "credits": 0 } ] }