取消或删除视频生成任务 API
取消排队中的视频生成任务,或者删除视频生成任务记录。
请求信息
| 项 | 值 |
|---|---|
| 请求方法 | DELETE |
| 请求地址 | https://ai-tokenhub.com/api/v3/contents/generations/tasks/id |
| Content-Type | application/json |
| 鉴权方式 | API Key 鉴权(Bearer Token) |
请求头
| 字段名 | 必填 | 说明 |
|---|---|---|
| Authorization | ✓ | 格式:Bearer <$YOUR_API_KEY>,与创建任务使用相同的 API 密钥 |
| Content-Type | ✓ | 固定值:application/json |
请求参数
Path 参数
id string 必选
需要取消或者删除的视频生成任务。
任务状态不同,调用 DELETE 接口,执行的操作有所不同,具体说明如下:
| 当前任务状态 | 是否支持 DELETE 操作 | 操作含义 | DELETE 操作后任务状态 |
|---|---|---|---|
| queued | 是 | 任务取消排队,任务状态被变更为 cancelled。 | cancelled |
| running | 否 | - | - |
| succeeded | 是 | 删除视频生成任务记录,后续将不支持查询。 | - |
| failed | 是 | 删除视频生成任务记录,后续将不支持查询。 | - |
| cancelled | 否 | - | - |
| expired | 是 | 删除视频生成任务记录,后续将不支持查询。 | - |
响应参数
本接口无返回参数。
