触站AI开放平台API
  1. 通用AI绘画(触站AI绘画)
触站AI开放平台API
  • 触站AI API接口使用说明
  • 返回结构
  • 更新历史
  • 基础
    • 获取当前客户详情以及积分情况
  • 工作流(AI小工具)
    • 1.获取工作流(小工具)字段详情
      POST
    • 2.提交工作流(小工具)任务执行
      POST
    • 3.获取工作流(小工具)任务进度或结果
      POST
  • 应用工具(电商工具)
    • 获取应用工具选项详情
    • 提交应用工具任务
  • 通用AI绘画(触站AI绘画)
    • 提交绘画任务积分计算说明
    • controlnet使用指南
    • 提交绘画任务
      POST
    • 获取绘画任务详情
      POST
    • 提交局部重绘绘画任务
      POST
  • 模型训练
    • 提交模型训练任务
    • 获取模型训练进度或者结果
  • MJ绘画
    • 提交Midjourney绘画任务
    • 使用Midjourney获取特定图片的画面描述
    • 提交Midjourney单图放大任务
    • 提交Midjourney单图扩写绘画任务
    • 提交Midjourney单图variation(变种)任务
    • 获取Midjourney任务详情(含进度)
  • 示例&DEMO
    • DEMO | 1分钟快速实现一个AI绘画页面
    • 高级模型 | 最能听懂人话的AI绘画模型-效果展示
    • 风格ID | 不同风格效果参考(内含ModelStyleID)
    • 示例 | 通过API实现图片中隐藏文字或者图案的效果
    • 示例 | 关于大尺寸图片参数的最佳实践(惊悚慎入)
    • 示例 | 使用回调获取任务结果的最佳实践
    • 示例 | 局部重绘处理
    • 示例 | 如何使用工作流接口进行绘图
    • 概念解析 | 工作流使用独立算力卡运行【独占模式】
    • 风格上新
      • 黏土风格
  1. 通用AI绘画(触站AI绘画)

提交绘画任务

POST
https://ai.huashi6.com/aiapi/v1/draw
最后修改时间:2024-01-31 05:54:35
此文档用于描述提交绘画的参数,此接口为异步提交任务接口,并不直接返回最终的绘画结果,请调用获取任务详情接口获取绘画的进度或者结果

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
prompt
string 
描述词条
必需
描述画面中需要出现的内容,支持中英文描述
详细词条技巧请参考此文章
negativePrompt
string 
负面词条
可选
用于排除画面中要出现的内容描述,支持中英文描述
modelStyleId
integer 
风格ID
必需
指定要生成对应风格预设的图片,触站AI官方会预设大量可以直接进行生产使用的风格预设,部分可用ID请参考此文档
此字段也可以使用模型训练API自定义风格产出的结果,详见模型训练
width
integer 
生成图片宽度
可选
在未使用高清修复的情况下,图片尺寸不建议设置过小,过小的尺寸会导致画面中的物体轮廓生成不完整,会造成比如人脸生成崩坏等问题的产生
>= 64<= 2048
默认值:
512
height
integer 
生成图片高度
可选
在未使用高清修复的情况下,图片尺寸不建议设置过小,过小的尺寸会导致画面中的物体轮廓生成不完整,会造成比如人脸生成崩坏等问题的产生
>= 64<= 2048
默认值:
512
resolutionPreset
enum<string> 
清晰度预设
可选
清晰度预设旨在通过一个简单的配置来自动设置多个参数来达到出特定清晰度图片效果,与web端清晰度选项功能对应。
注意:设置此字段会覆盖width、height、hrScale、upscale字段的值
枚举值:
normalhighultraextreme
aspectRatioPreset
enum<string> 
图片宽高比预设
可选
此字段会在保持总像素量(width*height)不变的前提下,重设width和height的值,用于快速设置出特定宽高比的图片
枚举值:
1:11:216:99:164:33:4
steps
integer 
绘图步数
可选
绘图步数与最终图片生成质量有关系,如果有更高的需求或者能够对画面质量降低有一定容忍度,可以尝试提高或者减少此值。
注意:modelStyleId中包含了默认steps预设,为获得最佳效果,不建议手动设置此参数
>= 1<= 50
img
string 
参考图片
可选
生成参考图,此字段传值则代表模式为图生图,同时支持base64数据格式和url(注意:url必须可以公网访问)
imgResizeMode
enum<integer> 
图片与width和height匹配模式
可选
这个参数指定了api如何对传入参数进行处理用于适配width和height生图,仅img有值的时候生效
枚举值:
01
默认值:
1
maskImg
string 
黑白二值遮罩蒙版图
可选
用于局部重绘处理,可以是图片URL或者base64格式字符串。
注意:遮罩图黑色区域代表需要重绘的部分
局部重绘功能请参考此文档
maskBlur
integer 
蒙版边缘羽化值
可选
可以通过设置此值用来调整遮罩蒙版边缘的模糊度,从而到达调整边缘契合度的效果
>= 0<= 100
denoisingStrength
number 
重绘幅度
可选
重绘幅度仅在img字段有传值的时候生效,重绘幅度越大代表生成图与原图越不相似,取值范围0~1
取值为0时,代表不会对img进行修改,出来的图与img几乎一致
取值为1是,代表对img进行完全修改,与img无任何相似
>= 0<= 1
默认值:
0.55
hrScale
number 
高清化倍率
可选
对生成的图片进行高清化处理,仅在文生图模式有效,取值范围为1~3之间
>= 1.1<= 3
hrSteps
integer 
高清处理步数
可选
高清迭代步数,(不建议少于15,会严重影响画面生成效果)
>= 5<= 30
upscale
integer 
ai算法放大倍率
可选
AI算法放大倍数
<= 3
seed
integer 
随机种子
可选
随机种子可以用于进行画面重现,默认不传则为随机生成
tiling
boolean 
花纹贴图
可选
是否生成花纹贴图,一般用于纹理生成使用
默认值:
false
batchSize
integer 
单次批量生成数量
可选
单次生成图片数量不可以超过6个
<= 6
默认值:
1
faceFix
boolean 
脸部修复开关
可选
开启后系统将会对生成图片人物脸部进行高级修复处理,大大改善人物脸部崩坏情况,开启需要单独扣减2积分
默认值:
false
detailsLevel
integer 
细节倍率
可选
取值范围为1~9小于5则画面偏向简单扁平话、草稿化大于5则画面偏向添加更多光影、服饰、头发等细节详细效果请参考此文章
>= 1<= 9
默认值:
5
cfgScale
number 
引导系数
可选
用于引导画面与描述词符合程度,取值1~30,取值越大越符合描述词,但是会限制AI发挥空间,取值小越不像描述词。(不同风格模型对此值有不同的预设,一般情况下此值不需要传,用风格默认即可)
>= 1<= 30
imgOptions
object 
图片高级功能参数
可选
可以通过一系列参数实现高级效果
removeBackground
boolean 
移除画面背景
可选
是否自动移除图片中的人物背景,一般用于重绘背景有效,注意:开启此功能需额外扣除2积分
默认值:
false
redrawBackground
boolean 
可选
是否保留画面中的主体,仅绘制画面中的背景注意:开启此功能需额外扣除2积分
默认值:
false
redrawBackgroundFromOrigin
boolean 
从原始背景中重绘
可选
是否完全清除原始背景,不从原始背景中重绘。
需要denoisingStrength设置为1,且搭配controlnet获得最好的效果
默认值:
true
mainObjectType
enum<string> 
可选
自定识别画面中的主体,用于背景相关处理。取值:
当removeBackground或者redrawBackground为true的时候,画面中的主体类型,请根据您的画面中的实际情况传值
枚举值:
generalhuman
默认值:
human
genderDetect
boolean 
可选
是否自动检测图片中的人物性别,尽量使生成前后的人物性别不发生变化,如果图片中有多个人物性别则效果会不准确。
注意,开启此功能需额外扣除1积分
默认值:
false
promptDetect
boolean 
自动识别图片中的词条
可选
用于生图的时候,自动检测图片中的词条生成(如果prompt有传,则会覆盖掉)
如果genderDetect 字段为true,则此字段不会生效
默认值:
false
facePreservation
boolean 
可选
自动检测图片中的人脸,使生成后的人脸与原始人脸保持高度相似。
注意,开启此功能需额外扣除2积分
默认值:
false
facePreservationCount
integer 
可选
开启人脸保持后,画面中最多处理的人脸数量,默认为1,最大值可以为5
>= 1<= 5
默认值:
1
img
string 
imgOptions参考图
可选
在最外层img参数没有传的时候,如果有传imgOptions的其他参数,则此img为必传,否则使用最外层img作为参考图(注意:redrawBackground、removeBackground仍然只在图生图模式下生效)
controlnet
object 
可选
controlnet功能实现,详细使用请参考此文档
units
array [object {9}] 
controlnet控制单元列表
必需
最多可以设置3个控制单元,最少需要设置一个
image
string 
默认控制图
可选
如果此字段传值,可以在controlnet的unit中没有传对应的image时候,用此image进行控制,可以认为是一个默认控制图
支持base64与图片url(需公网url)
示例值:
https://test.image.com/test.jpg
predictConsume
boolean 
预测模拟积分消耗
可选
如果传值为true则代表本次是测试模拟积分消耗量,不进行真正的绘画操作,仅用于计算同参数下积分消耗量,不扣减任何积分
默认值:
false
callback
string 
结果回调地址
可选
支持IP等URL请参考回调使用指南
示例值:
https://exmple.com/callback
nonce
string 
自定义请求回调标识
可选
任意长度不超过32的字符串,具体请参考回调使用指南
<= 32 字符
示例
{
  "prompt": "一个女孩",
  "modelStyleId": 1
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ai.huashi6.com/aiapi/v1/draw' \
--header 'Content-Type: application/json' \
--data-raw '{
    "prompt": "一个女孩",
    "modelStyleId": 1
}'

返回响应

🟢200成功
application/json
Body
data
object 
必需
paintingSign
string 
绘画任务ID
可选
可以用于绘画详情接口查询进度或者获取结果,如果predictConsume为true则接口不会返回此值
请妥善记录保管此值,如果遇到问题需要进行调试排查请提供具体任务的此字段给我们
taskLimitCount
integer 
任务限制数
可选
并发任务数
used
integer 
本次扣减积分
可选
balance
integer 
账户当前余额
必需
estimateUsed
integer 
预计消耗积分量
可选
仅predictConsume为true时才返回此值
consumeDetail
array [object {2}] 
参数需要消耗积分明细
可选
仅predictConsume为true时才返回此值
code
integer 
API统一响应码
必需
错误码请参考此文档
msg
string 
错误消息
必需
如果本次接口请求错误,则会返回对应的错误描述
success
boolean 
是否处理成功
必需
简易字段用于区分本次请求接口是否处理成功
示例
{
  "data": {
    "paintingSign": "74cda5279c6a4097980079fe87b486b9",
    "used": 4,
    "balance": 9996
  },
  "code": 0,
  "success": true
}
上一页
controlnet使用指南
下一页
获取绘画任务详情
Built with