本文档由云音工坊自动生成，如有疑问，请联系客服微信：yuntts ！

取消任务

开发中

POST

https://www.yuntts.com/api/v1/indextts25/cancel

取消任务

POST https://www.yuntts.com/api/v1/indextts25/cancel

任务开始生成之前可以取消；已经结束的任务不能取消。取消成功后预扣积分会自动退回。

4.1 请求参数

参数	类型	必填	说明
`task_id`	String	是	创建任务时返回的 `task_id`

4.2 返回参数

参数	类型	说明
`data.task_id`	String	任务 ID
`data.status`	String	取消成功固定为 `refunded`（已退款）

{
  "code": 200,
  "message": "已取消",
  "data": {
    "task_id": "indextts25_api_68f2c1a0b3d47_1790984300",
    "status": "refunded"
  }
}

4.3 错误码

HTTP	error	说明
400	`missing_task_id`	没传 `task_id`
400	`task_finished`	任务已结束，无法取消
404	`task_not_found`	任务不存在，或不属于当前账号
502	`cancel_failed`	取消失败（任务可能已经开始生成）

请求参数

Header 参数

Body 参数application/json必填

示例

{
    "task_id": "string"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://www.yuntts.com/api/v1/indextts25/cancel' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
    "task_id": "string"
}'

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "code": 200,
    "message": "已取消",
    "data": {
        "task_id": "indextts25_api_68f2c1a0b3d47_1790984300",
        "status": "refunded"
    }
}

修改于 2026-10-03 01:13:52

查询任务

查询音色列表

取消任务

取消任务#

4.1 请求参数#

4.2 返回参数#

4.3 错误码#

请求参数

请求示例代码

返回响应

取消任务

4.1 请求参数

4.2 返回参数

4.3 错误码