取消或删除视频生成任务
本接口用于取消排队中的视频生成任务,或删除已终止任务的记录。根据任务当前状态的不同,调用效果也不同,详见下方说明。
请求方法
DELETE:<ai-api-base-url>/llm/v1/contents/generations/tasks/{task_id}
其中,<ai-api-base-url> 为您的 API Key 所属数据中心的域名:
- 北京数据中心:
https://ai.rong-api.com - 北美数据中心:
https://ai.us-light-api.com
请求头参数
| 参数名 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| Authorization | string | 是 | - | 身份认证令牌,格式为 Bearer <your API key>,需替换为实际 API Key,用于验证用户权限。 |
路径参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| task_id | string | 是 | 需要取消或删除的视频生成任务 ID。 |
各状态下的操作行为
| 当前任务状态 | 是否支持 DELETE | 操作含义 | 操作后状态 |
|---|---|---|---|
| queued(排队中) | 是 | 取消任务排队,任务状态变更为 cancelled | cancelled |
| running(生成中) | 否 | 不支持 | - |
| succeeded(已完成) | 是 | 删除任务记录,后续将无法查询 | - |
| failed(已失败) | 是 | 删除任务记录,后续将无法查询 | - |
| cancelled(已取消) | 否 | 不支持 | - |
| expired(已超时) | 是 | 删除任务记录,后续将无法查询 | - |
请求示例
- cURL
- Python
- JavaScript
bash
curl --request DELETE \
--url '<ai-api-base-url>/llm/v1/contents/generations/tasks/cgt-2025xxxxxx-xxxx' \
--header 'Authorization: Bearer <token>'
python
import requests
task_id = "cgt-2025xxxxxx-xxxx" # 替换为实际任务 ID
headers = {
"Authorization": "Bearer <token>"
}
response = requests.delete(
f"<ai-api-base-url>/llm/v1/contents/generations/tasks/{task_id}",
headers=headers
)
print(response.status_code)
JavaScript
const taskId = 'cgt-2025xxxxxx-xxxx'; // 替换为实际任务 ID
const options = {
method: 'DELETE',
headers: {
'Authorization': 'Bearer <token>'
}
};
fetch(`<ai-api-base-url>/llm/v1/contents/generations/tasks/${taskId}`, options)
.then(response => {
if (response.ok) {
console.log('操作成功');
} else {
return response.json().then(err => console.error('操作失败:', err));
}
})
.catch(err => console.error(err));
返回结果
本接口无返回参数,操作成功时返回 HTTP 200 状态码。