调用流程

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

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

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

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

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

提示词（prompt）预处理

POST

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

接口能力

本接口用于「中译英转译」「敏感词检测」等描述词优化

用户输入的描述词可能是中文，或者包含敏感词，建议用本接口做敏感词监测并转为英文后再做 AI 绘画图像生成

积分扣除规则

一次调用消耗 0.5 积分

提示词预处理接口支持积分模式按次调用；
包月用户和部署用户不限次调用（限时优惠）

请求参数

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

text

string

用户输入的文本

必需

示例值:

一只可爱的小猫

need_translate

boolean

是否需要翻译

已废弃

默认值:

true

enable_recommend

boolean

是否启用 prompt 推荐

可选

默认值:

false

示例

{
    "text": "错综复杂 优雅 高度详细 Rebort Baggo ",
    "need_translate": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.nolibox.com/prod-open-aigc/engine/get_prompt' \
--header 'Authorization: Basic xxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "错综复杂 优雅 高度详细 Rebort Baggo ",
    "need_translate": true
}'

返回响应

🟢200成功

application/json

Body

text

string

预处理后的提示词

必需

success

boolean

预处理是否成功

必需

reason

string

如果 success=False，则记录失败的原因

必需

recommend_prompts

array [object {2}]

prompt 推荐列表

必需

text

string

提示词内容

必需

image_url

string

示例图片 URL

必需

示例

{
    "text": "string",
    "success": true,
    "reason": "string",
    "recommend_prompts": [
        {
            "text": "string",
            "image_url": "string"
        }
    ]
}

修改于 2023-03-14 00:35:35

提交任务接口（画宇宙系列模型）

提示词（prompt）预处理

接口能力#

积分扣除规则#

请求参数

示例代码

返回响应

接口能力

积分扣除规则