调用流程

调用 /push 类接口提交任务
调用 /status 接口查询任务状态（排队情况，是否完成，返回的结果等）

接口分为域名，环境标识和路径三部分，其中：

域名：https://open.nolibox.com
正式环境标识：prod-open-aigc
路径：如 /engine/push或 /engine/status 等

最终请求地址为域名/环境标识/路径

如 https://open.nolibox.com/prod-open-aigc/engine/push

中断已提交任务

POST

https://open.nolibox.com/prod-open-aigc/engine/interrupt

接口能力

主动取消正在排队（pending 状态）的任务，取消成功后积分用户会退还任务积分。

只支持对/engine/push 和 /engine/push/controlnet 两个接口提交的任务发起取消操作。

积分扣除规则

免费

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization

string

必需

此值可以在开放平台(https://open.creator.nolibox.com) - 应用列表 - 操作中的"TOKEN"中获取。计算方式："Basic " + Base64.encode(App Key:App Secret)

示例值:

Basic xxxxxxxxxx

Body 参数application/json

uid

string

任务唯一 ID

必需

示例

{
    "uid": "e4206b1bc050dffd80f7df6049435c73"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.nolibox.com/prod-open-aigc/engine/interrupt' \
--header 'Authorization: Basic xxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uid": "e4206b1bc050dffd80f7df6049435c73"
}'

返回响应

🟢200成功

application/json

Body

success

boolean

是否取消成功

必需

reason

string

失败原因

必需

示例

{
    "success": true,
    "reason": ""
}

修改于 2023-04-12 16:43:45

提交 ControlNet 任务

提交 Draft 任务

中断已提交任务

接口能力#

积分扣除规则#

请求参数

示例代码

返回响应

接口能力

积分扣除规则