MaaS 产品文档
POST
图片生成接口地址
https://maas-api.cn-huabei-1.xf-yun.com/v2.1/tti
POST
调用Kolors时使用此地址
https://xingchen-api.cn-huabei-1.xf-yun.com/v2.1/tti
API Key：点击 API调用 / APIKEY管理 界面获取，示例：ak-f30b1********fc84b82e86a
Model ID：点击 API调用 获取

1 请求参数 ​

接口请求字段由三个部分组成：header，parameter, payload。 字段解释如下：

  1. Header参数
APIKEY
string必填
点击API调用/APIKEY管理界面获取
示例：ak-f30b1\*\*\*\*\*\*\*\*fc84b82e86a
uid
string可选
参数要求：最大长度32
每个用户的id，用于区分不同用户
patch_id
string可选
非全量训练的模型需要传入patch_id，可从平台网页获取
  1. Parameter.Chat参数
domain
string必填
参数要求：取值为用户服务的modelID
modelID可从星辰网页获取
width
int必填
参数要求：选取平台支持的分辨率,默认值为512
图片的宽度
height
int必填
参数要求：选取平台支持的分辨率，默认值为512
图片的高度
seed
int必填
参数要求：范围0\~INT\_MAX
产生图片的随机种子
num_inference_steps
int必填
参数要求：范围0\~50，默认值为20
产生图片的步长数
guidance_scale
float必填
参数要求：值范围0\~20.0，默认值为5.0
提示词相关度，越大越相关
scheduler
string必填
参数要求：默认值'DPM++ 2M Karras'
调度器

分辨率可支持的有768x768 1024x1024 576x1024 768x1024 1024x576 1024x768 scheduler支持的有'DPM++ 2M Karras','DPM++ SDE Karras','DDIM','Euler a','Euler'

注意

FLUX.1-dev模型所有参数均为默认值，暂不支持更改。

  1. payload参数
message.text.role
string必填
参数要求：取值为"user"
user表示是用户的问题
message.text.content
string必填
参数要求：不得超过1024个字符
文本内容，图片生成指令
message.negative_prompts
string可选
参数要求：不得超过1024个字符
在进行文本生成时，可以提供一些负面或反向的示例，以帮助模型生成更符合期望的输出

2 请求示例 ​

以下示例展示了一个完整的请求结构：

json
 {
        "Authorization" :"Bearer YOURKEY",  // 请替换YOURKEY为您的 APIpassword
        "content-type"  : "application/json"
    }
请求体

    {
        "header": {
            "uid": "12345"
            "patch_id":["123456"]
        },
        "parameter": {
            "chat": {
                "domain": "<your-modelID>",
                "width":768,
                "height":768,
                "seed":42,
                "num_inference_steps":20,
                "guidance_scale":5.0,
                "scheduler":"Euler",
            }
        },
        "payload": {
            "message": {
                "text": [
                    {"role": "user", "content": "Draw a mountain."}
                ]
            },
            "negative_prompts":{
                "text":"black and white"
            }
        }
    }

3 响应 ​

  1. 成功响应示例
json
{
    "header": {
        "code": 0,
        "message": "Success",
        "sid": "cht000704fa@dx16ade44e4d87a1c802",
        "status": 0
    },
    "payload": {
        "choices": {
            "status": 2,
            "seq": 0,
            "text": [
                {
                    "content": "base64",
                    "index": 0,
                    "role": "assistant"
                }
            ]
        }
    }
}
  1. 异常结果示例
json
{
  "header": {
    "code": 10003,
    "message": "xxxx",
    "sid": "cht00120013@dx181c8172afb0001102",
    "status": 2
  }
}
  1. 响应参数说明

header参数

code
int
错误码，0表示正常，非0表示出错；详细释义可在接口说明文档最后的错误码说明了解
message
string
会话是否成功的描述信息
sid
string
会话的唯一id，用于讯飞技术人员查询服务端会话日志使用,出现调用错误时建议留存该字段
status
int
会话的状态 ，文生图场景下为2
  1. 响应数据解析

payload.choices

status
int
数据状态 ，0:开始, 1:开始, 2:结束（表示文本响应结束）
seq
int
返回的数据序号，取值为\[0,9999999\]
text.content
string
返回的base64图片结果，默认分辨率512\*512
text.role
string
角色标识，固定为assistant，标识角色为AI
text.index
int
结果序号，在多候选中使用