Cancel or Delete Video Generation Task API
Cancel a queued video generation task, or delete a video generation task record.
Request Information
| Item | Value |
|---|---|
| Request Method | DELETE |
| Request URL | https://ai-tokenhub.com/api/v3/contents/generations/tasks/id |
| Content-Type | application/json |
| Authentication | API Key Authentication (Bearer Token) |
Request Headers
| Field Name | Required | Description |
|---|---|---|
| Authorization | ✓ | Format: Bearer <$YOUR_API_KEY>, same API key used for task creation |
| Content-Type | ✓ | Fixed value: application/json |
Request Parameters
Path Parameters
id string Required
The video generation task to be cancelled or deleted.
Depending on the task status, calling the DELETE interface performs different operations, as detailed below:
| Current Task Status | DELETE Supported | Operation Meaning | Task Status After DELETE |
|---|---|---|---|
| queued | Yes | Task is cancelled from queue, task status is changed to cancelled. | cancelled |
| running | No | - | - |
| succeeded | Yes | Delete video generation task record, no longer queryable. | - |
| failed | Yes | Delete video generation task record, no longer queryable. | - |
| cancelled | No | - | - |
| expired | Yes | Delete video generation task record, no longer queryable. | - |
Response Parameters
This interface has no return parameters.