触站AI开放平台API

提交应用工具任务

开发中

POST/aiapi/utilityTool/run

最后修改时间： 1 个月前

该接口用于提交应用工具任务，所需的参数详情可通过应用工具选项详情接口获取，此接口为异步提交任务接口，并不直接返回最终的结果，请调用获取工作流任务详情接口获取进度或者结果。

使用此接口需要提交的参数需要通过获取应用工具选项获取，字段对应关系如下：

企业微信截图_b167263b-e973-450b-b9ee-e3db4c5bacb3.png

请求参数

utilityToolId

integer

应用工具ID

必需

presetId

integer

预设模板id

可选

options

array [object {2}]

相关选项

必需

integer

选项ID

必需

itemId

integer

选项值ID

必需

image

string

图片

必需

图片url或base64

imageMask

string

遮罩图

可选

图片url或base64

exclusiveMode

boolean

是否开启独占模式

可选

callback

string

结果回调地址

可选

支持IP等URL请参考回调使用指南

示例值:

https://exmple.com/callback

nonce

string

自定义请求回调标识

可选

任意长度不超过32的字符串，具体请参考回调使用指南

<= 32 字符

{
  "utilityToolId": 0,
  "presetId": 0,
  "options": [
    {
      "id": 0,
      "itemId": 0
    }
  ],
  "image": "string",
  "imageMask": "string",
  "exclusiveMode": true,
  "callback": "https://exmple.com/callback",
  "nonce": "string"
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

data

object

必需

taskId

string

绘画任务ID

必需

可以用于工作流绘画详情接口查询进度或者获取结果
请妥善记录保管此值，如果遇到问题需要进行调试排查请提供具体任务的此字段给我们

used

integer

本次扣减积分

必需

balance

integer

账户当前余额

必需

taskLimit

integer

任务限制数

必需

并发任务数

code

integer

API统一响应码

必需

错误码请参考此文档

msg

string

错误消息

必需

如果本次接口请求错误，则会返回对应的错误描述

success

boolean

是否处理成功

必需

简易字段用于区分本次请求接口是否处理成功

{
  "data": {
    "taskId": "string",
    "used": 0,
    "balance": 0,
    "taskLimit": 0
  },
  "code": 0,
  "msg": "string",
  "success": true
}

最后修改时间： 1 个月前