TonaAi-OpenAPI接口文档
Base URLs: https://openapi.tonaai.cn
openapi/v1/file
POST 上传文件
POST /v1/file/upload
Body 请求参数
file: file://C:\Users\tansor\Desktop\test.docx
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ApiKey | header | string | 是 | 在控制台的个人主页获取 |
| body | body | object | 否 | none |
| » file | body | string(binary) | 否 | none |
返回示例
200 Response
{
"fileId": 0,
"wordNum": 0
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » fileId | number | true | none | 文件ID | |
| » wordNum | number | true | none | 字数 |
openapi/v1/task
POST AIGC检测
POST /v1/task/aigc_check
app_id：默认写1001
时间戳字符串生成示例：String timestamp = java.time.ZonedDateTime.now().toString();系统允许三分钟以内的时间误差
随机字符串生成示例：String nonceStr = java.util.UUID.randomUUID().toString().replace("-", "").substring(0, 16);
Body 请求参数
{
"app_id": "string",
"timestamp": "string",
"nonce_str": "string",
"data": {
"title": "string",
"author": "string",
"fileId": 0
}
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ApiKey | header | string | 是 | 在控制台的个人主页获取 |
| body | body | object | 否 | none |
| » app_id | body | string | 是 | 默认1001 |
| » timestamp | body | string | 是 | 时间戳 |
| » nonce_str | body | string | 是 | 随机字符串 |
| » data | body | object | 是 | none |
| »» title | body | string | 是 | 文章标题 |
| »» author | body | string | 是 | 文章作者 |
| »» fileId | body | number | 是 | 文件ID |
返回示例
200 Response
{
"code": 0,
"message": "string",
"data": {
"taskId": "string"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | 0-成功，1-失败 | |
| » message | string | true | none | 请求失败时此处可能会有消息提示 | |
| » data | object | true | none | none | |
| »» taskId | string | true | none | 任务id |
POST 降AI率
POST /v1/task/reduce_ai_rate
app_id：默认写1001
时间戳字符串生成示例：String timestamp = java.time.ZonedDateTime.now().toString();系统允许三分钟以内的时间误差
随机字符串生成示例：String nonceStr = java.util.UUID.randomUUID().toString().replace("-", "").substring(0, 16);
Body 请求参数
{
"app_id": "string",
"timestamp": "string",
"nonce_str": "string",
"data": {
"origin": "string",
"type": "string",
"lang": "string",
"mode": "string"
}
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ApiKey | header | string | 是 | 在控制台的个人主页获取 |
| body | body | object | 否 | none |
| » app_id | body | string | 是 | 默认1001 |
| » timestamp | body | string | 是 | 时间戳 |
| » nonce_str | body | string | 是 | 随机字符串 |
| » data | body | object | 是 | none |
| »» origin | body | string | 是 | 文本内容或者文件ID |
| »» type | body | string | 是 | text-文本，file-文件 |
| »» lang | body | string | 是 | cn-中文，en-英文 |
| »» mode | body | string | 是 | normal-普通，powerful-强力 |
返回示例
200 Response
{
"code": 0,
"message": "string",
"data": {
"taskId": "string",
"cost": 0
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | 0-成功，1-失败 | |
| » message | string | true | none | 请求失败时此处可能会有消息提示 | |
| » data | object | true | none | none | |
| »» taskId | string | true | none | 任务id | |
| »» cost | number | true | none | 此任务的消费金额 |
POST 降重复率
POST /v1/task/reduce_rp_rate
app_id：默认写1001
时间戳字符串生成示例：String timestamp = java.time.ZonedDateTime.now().toString();系统允许三分钟以内的时间误差
随机字符串生成示例：String nonceStr = java.util.UUID.randomUUID().toString().replace("-", "").substring(0, 16);
Body 请求参数
{
"app_id": "string",
"timestamp": "string",
"nonce_str": "string",
"data": {
"origin": "string",
"type": "string",
"lang": "string",
"mode": "string"
}
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ApiKey | header | string | 是 | 在控制台的个人主页获取 |
| body | body | object | 否 | none |
| » app_id | body | string | 是 | 默认1001 |
| » timestamp | body | string | 是 | 时间戳 |
| » nonce_str | body | string | 是 | 随机字符串 |
| » data | body | object | 是 | none |
| »» origin | body | string | 是 | 文本内容或者文件ID |
| »» type | body | string | 是 | text-文本，file-文件 |
| »» lang | body | string | 是 | cn-中文，en-英文 |
| »» mode | body | string | 是 | normal-普通，powerful-强力 |
返回示例
200 Response
{
"code": 0,
"message": "string",
"data": {
"taskId": "string"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | 0-成功，1-失败 | |
| » message | string | true | none | 请求失败时此处可能会有消息提示 | |
| » data | object | true | none | none | |
| »» taskId | string | true | none | 任务id |
openapi/v1/useRecord
POST 批量查询结果
POST /v1/use_record/batch_record
Body 请求参数
[
0
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ApiKey | header | string | 是 | 在控制台的个人主页获取 |
| body | body | array[integer] | 否 | none |
返回示例
200 Response
{
"code": 0,
"message": "string",
"data": [
{
"id": 0,
"productId": 0,
"cost": 0,
"wordNum": 0,
"title": "string",
"author": "string",
"origin": "string",
"result": "string",
"status": "string",
"note": "string"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | 0-成功，1-失败 | |
| » message | string | true | none | 请求失败时此处可能会有消息提示 | |
| » data | [object] | true | none | none | |
| »» id | integer | true | none | 任务id | |
| »» productId | integer | true | none | 产品id | |
| »» cost | number | true | none | 任务费用 | |
| »» wordNum | integer | true | none | 字数 | |
| »» title | string | true | none | 文章标题 | |
| »» author | string | true | none | 文章作者 | |
| »» origin | string | true | none | 原文的文件链接 | |
| »» result | string | true | none | 处理结果的文件链接 | |
| »» status | string | true | none | 任务状态（-1-失败,0-待处理,1-处理中,2-处理成功,3-处理失败），注意这是string不是integer | |
| »» note | string | true | none | 备注信息 |
openapi/v1/user
GET 查询余额
GET /v1/user/balance
为了高可用性，提交任务时不会检查余额，所以批量提交任务并发写入数据库时可能导致余额变成负数，是正常现象
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ApiKey | header | string | 是 | 在控制台的个人主页获取 |
返回示例
200 Response
{
"code": 0,
"message": "string",
"data": 0
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | 0-成功，1-失败 | |
| » message | string | true | none | 请求失败时此处可能会有消息提示 | |
| » data | number | true | none | 账户余额 |