图片生成 API
GET
http(s): //spark-api.cn-huabei-1.xf-yun.com/v2.1/tti图片生成 API 文档
#接口说明
- 根据用户输入的文字内容,生成符合语义描述的不同风格的图像
- 部分开发语言demo如下,其他开发语言请参照文档进行开发,也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
图片生成 demo go语言 - 集成图片生成时,需按照以下要求:
内容 | 说明 |
---|---|
传输方式 | http[s] (为提高安全性,强烈推荐https) |
请求地址 | http(s): //spark-api.cn-huabei-1.xf-yun.com/v2.1/tti 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
Content-Type | application/json;charset=UTF-8 |
接口鉴权 | 签名机制,详情请参照签名生成 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器 |
#鉴权说明
在调用业务接口时,请求方需要对请求进行签名,服务端通过签名来校验请求的合法性。
#鉴权方法
详情请参照下方签名生成
#鉴权结果
如果鉴权失败,则根据不同错误类型返回不同HTTP Code状态码,同时携带错误描述信息,详细错误说明如下:
HTTP Code | 说明 | 错误描述信息 | 解决方法 |
---|---|---|---|
401 | 缺少authorization参数 | {"message":"Unauthorized"} | 检查是否有authorization参数,详情见authorization参数详细生成规则 |
401 | 签名参数解析失败 | {“message”:”HMAC signature cannot be verified”} | 检查签名的各个参数是否有缺失是否正确,特别确认下复制的api_key是否正确 |
401 | 签名校验失败 | {“message”:”HMAC signature does not match”} | 签名验证失败,可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host,date,request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。 |
403 | 时钟偏移校验失败 | {“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”} | 检查服务器时间是否标准,相差5分钟以上会报此错误 |
时钟偏移校验失败示例:
HTTP/1.1 403 Forbidden
Date: Mon, 22 May 2023 05:44:14 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
"message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}
常见问题
#图片生成的主要功能是什么?
答:根据用户输入的文字内容,生成符合语义描述的不同风格的图像。
#图片生成支持什么应用平台?
答:目前支持Web API应用平台。
#图片生成的默认大小为多少?
答:分辨率512*512。
请求参数
Body 参数application/json
header
object
必需
app_id
string
必需
应用的app_id,需要在飞云交互平台申请,"maxLength":8
parameter
object
必需
chat
object
必需
payload
object
必需
message
object
必需
示例
{
"header": {
"app_id": "your_appid"
},
"parameter": {
"chat": {
"max_tokens": 4096,
"domain": "general",
"temperature": 0.5
}
},
"payload": {
"message": {
"text": [
{
"role": "user",
"content": "帮我画一座山"
}
]
}
}
}
示例代码
返回响应
成功(200)
请求有误(400)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
header
object
必需
code
integer
必需
服务错误码 , 0表示正常,非0表示出错
message
string
必需
返回消息描述 ,错误码的描述信息
sid
string
会话的sid
status
integer
必需
会话的状态 ,文生图场景下为2
payload
object
必需
choices
object
必需
示例
成功示例
{
"header": {
"code": 0,
"message": "Success",
"sid": "cht000704fa@dx16ade44e4d87a1c802",
"status": 0
},
"payload": {
"choices": {
"status": 2,
"seq": 0,
"text": [
{
"content": "base64",
"index": 0,
"role": "assistant"
}
]
}
}
}
最后修改时间: 1 年前