星芸AI API开发文档
  1. 任务查询
星芸AI API开发文档
  • 文档说明
  • API身份认证
  • API请求
  • API模型接口
    • 模型名称
      • 模型名称获取
    • 对话接口
      • 对话接口
    • 文本补全接口
      • 文本补全接口
    • 图像生成/识别接口
      • 图像生成接口
      • 图像识别接口
    • 向量嵌入接口
      • 向量嵌入接口
    • AI绘图(MJ绘图)接口
      • 任务提交
        • 执行动作
        • 提交Blend任务
        • 提交Describe任务
        • 提交Imagine任务
        • 提交Modal
        • 提交Shorten任务
      • 任务查询
        • 查询所有任务
          GET
        • 根据ID列表查询任务
          POST
        • 查询任务队列
          GET
        • 指定ID获取任务
          GET
        • 获取任务图片的seed
          GET
    • 开放插件(Plugin)接口
      • 联网接口
        • 联网(增强)接口
    • 语音/文本接口
      • 文本转语音(TTS)
      • 语音转文本(STT)
  • 常见问题
  • API调用错误码汇总
  1. 任务查询

指定ID获取任务

测试中
正式环境
正式环境
GET
https://aiapi.xing-yun.cn
/mj/task/{id}/fetch
任务查询

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
id
string 
任务ID
必需

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://aiapi.xing-yun.cn/mj/task//fetch'

返回响应

🟢200OK
application/json
Body
action
enum<string> 
任务类型
可选
枚举值:
IMAGINEUPSCALEVARIATIONZOOMPANDESCRIBEBLENDSHORTEN
buttons
array[object (可执行按钮) {5}] 
可选
customId
string 
动作标识
可选
emoji
string 
图标
可选
label
string 
文本
可选
style
integer <int32>
可选
样式: 2(Primary)、3(Green)
type
integer <int32>
类型,系统内部使用
可选
description
string 
任务描述
可选
failReason
string 
失败原因
可选
finishTime
integer <int64>
结束时间
可选
id
string 
ID
可选
imageUrl
string 
图片url
可选
progress
string 
任务进度
可选
prompt
string 
提示词
可选
promptEn
string 
提示词-英文
可选
properties
object 
可选
startTime
integer <int64>
开始执行时间
可选
state
string 
自定义参数
可选
status
enum<string> 
任务状态
可选
枚举值:
NOT_STARTSUBMITTEDMODALIN_PROGRESSFAILURESUCCESS
submitTime
integer <int64>
提交时间
可选
示例
{
  "action": "IMAGINE",
  "buttons": [
    {
      "customId": "string",
      "emoji": "string",
      "label": "string",
      "style": 0,
      "type": 0
    }
  ],
  "description": "string",
  "failReason": "string",
  "finishTime": 0,
  "id": "string",
  "imageUrl": "string",
  "progress": "string",
  "prompt": "string",
  "promptEn": "string",
  "properties": {},
  "startTime": 0,
  "state": "string",
  "status": "NOT_START",
  "submitTime": 0
}
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
修改于 2023-12-14 11:34:47
上一页
查询任务队列
下一页
获取任务图片的seed
Built with