{
  "openapi": "3.0.3",
  "info": {
    "title": "AI绘画",
    "description": "借助全球新兴的AIGC技术，我们为您提供了一种随心所欲、自然流畅且高能硬核的AI作图能力。您只需简单描述，即可实现图像的创作和生成，甚至可以通过输入的图像进行再创作。我们的技术广泛应用于广告营销、媒体、出版物、游戏开发、艺术创作和摄影后期处理等各种场景。",
    "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://route.showapi.com"
    }
  ],
  "paths": {
    "/3041-4": {
      "x-pointCode": 4,
      "x-mode": "mapping",
      "x-read-timeout": 5,
      "x-connect-timeout": 5,
      "post": {
        "summary": "查询绘画任务历史记录",
        "description": "任务结果图片我们只保留24小时，请您及时保存图片",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "allPages": {
                              "type": "number",
                              "description": "列表总页数"
                            },
                            "ret_code": {
                              "type": "number",
                              "description": "0表示查询成功"
                            },
                            "contentlist": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "result_list": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    },
                                    "description": "任务创作结果列表，这些图片我们只保留24小时，请您及时保存"
                                  },
                                  "scale": {
                                    "type": "string",
                                    "description": "创作任务的scale值"
                                  },
                                  "cause": {
                                    "type": "string",
                                    "description": "任务创作失败原因"
                                  },
                                  "scheduler": {
                                    "type": "string",
                                    "description": "任务采样算法"
                                  },
                                  "status": {
                                    "type": "string",
                                    "description": "任务状态，有waiting,finish,fail三种状态"
                                  },
                                  "seed": {
                                    "type": "string",
                                    "description": "任务随机种子"
                                  },
                                  "width": {
                                    "type": "string",
                                    "description": "任务创作的图片宽度"
                                  },
                                  "task_id": {
                                    "type": "string",
                                    "description": "任务id"
                                  },
                                  "batch_size": {
                                    "type": "string",
                                    "description": "任务创作的图片数量"
                                  },
                                  "steps": {
                                    "type": "string",
                                    "description": "任务设定的创作步骤数"
                                  },
                                  "negetive_prompt": {
                                    "type": "string",
                                    "description": "任务反向提示词"
                                  },
                                  "lora_scale": {
                                    "type": "string",
                                    "description": "lora scale值"
                                  },
                                  "ct": {
                                    "type": "string",
                                    "description": "任务提交时间"
                                  },
                                  "height": {
                                    "type": "string",
                                    "description": "任务创作的图片高度"
                                  },
                                  "call_back": {
                                    "type": "string",
                                    "description": "任务成功的回调地址"
                                  },
                                  "prompt": {
                                    "type": "string",
                                    "description": "任务提示词"
                                  }
                                }
                              },
                              "description": "历史任务列表"
                            },
                            "currentPage": {
                              "type": "number",
                              "description": "列表当前页"
                            },
                            "allNum": {
                              "type": "number",
                              "description": "历史总任务数"
                            },
                            "maxResult": {
                              "type": "number",
                              "description": "每页最大任务数"
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3041_4_POST",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "查询的任务列表页码，每页最大返回10条任务记录",
            "required": false,
            "schema": {
              "type": "number"
            }
          }
        ]
      }
    },
    "/3041-3": {
      "x-pointCode": 3,
      "x-mode": "mapping",
      "x-read-timeout": 5,
      "x-connect-timeout": 5,
      "post": {
        "summary": "查询绘画任务详情",
        "description": "任务结果图片我们只保留24小时，请您及时保存图片",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "result_list": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              },
                              "description": "任务创作结果列表，这些图片我们只保留24小时，请您及时保存"
                            },
                            "scale": {
                              "type": "string",
                              "description": "创作任务的scale值"
                            },
                            "cause": {
                              "type": "string",
                              "description": "任务创作失败原因"
                            },
                            "status": {
                              "type": "string",
                              "description": "任务状态，有waiting,finish,fail三种状态"
                            },
                            "scheduler": {
                              "type": "string",
                              "description": "任务采样算法"
                            },
                            "remark": {
                              "type": "string",
                              "description": "查询的错误信息"
                            },
                            "seed": {
                              "type": "string",
                              "description": "任务随机种子"
                            },
                            "width": {
                              "type": "string",
                              "description": "任务创作的图片宽度"
                            },
                            "task_id": {
                              "type": "string",
                              "description": "任务id"
                            },
                            "batch_size": {
                              "type": "string",
                              "description": "任务创作的图片数量"
                            },
                            "steps": {
                              "type": "string",
                              "description": "任务设定的创作步骤数"
                            },
                            "negetive_prompt": {
                              "type": "string",
                              "description": "任务反向提示词"
                            },
                            "lora_scale": {
                              "type": "string",
                              "description": "lora scale值"
                            },
                            "ct": {
                              "type": "string",
                              "description": "任务提交时间"
                            },
                            "ret_code": {
                              "type": "number",
                              "description": "0表示找到任务，-1表示没有找到任务"
                            },
                            "height": {
                              "type": "string",
                              "description": "任务创作的图片高度"
                            },
                            "call_back": {
                              "type": "string",
                              "description": "任务成功的回调地址"
                            },
                            "prompt": {
                              "type": "string",
                              "description": "任务提示词"
                            },
                            "label": {
                              "type": "string",
                              "description": "生成违规内容标签，生成内容正常为空字符串，若出现nsfw代表公共场所不宜展示内容，pornographic代表色情内容，sexual代表性暗示内容，political代表涉政内容，violent代表暴力火血腥恐怖内容，contraband代表赌博内容，suggestiveContent代表低俗内容"
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3041_3_POST",
        "parameters": [
          {
            "name": "task_id",
            "in": "query",
            "description": "要查询的任务id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/3041-1": {
      "x-pointCode": 1,
      "x-mode": "mapping",
      "x-read-timeout": 5,
      "x-connect-timeout": 5,
      "post": {
        "summary": "提交绘画生成任务",
        "description": "使用提示词创建一个绘画任务",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "result_list": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              },
                              "description": "结果数组"
                            },
                            "scale": {
                              "type": "number",
                              "description": "创作绘画强度"
                            },
                            "cause": {
                              "type": "string",
                              "description": "任务创作失败的原因"
                            },
                            "status": {
                              "type": "string",
                              "description": "任务状态，有waiting,fail,finish三个状态"
                            },
                            "scheduler": {
                              "type": "string",
                              "description": "使用的采样算法代码（不可修改）"
                            },
                            "remark": {
                              "type": "string",
                              "description": "任务提交失败的原因"
                            },
                            "seed": {
                              "type": "number",
                              "description": "随机种子数"
                            },
                            "width": {
                              "type": "number",
                              "description": "图片宽度"
                            },
                            "task_id": {
                              "type": "string",
                              "description": "该任务的task_id"
                            },
                            "batch_size": {
                              "type": "number",
                              "description": "创作图片数量"
                            },
                            "steps": {
                              "type": "number",
                              "description": "创作步数"
                            },
                            "negetive_prompt": {
                              "type": "string",
                              "description": "反向提示词（不可修改）"
                            },
                            "lora_scale": {
                              "type": "string",
                              "description": "lora模型强度"
                            },
                            "ret_code": {
                              "type": "number",
                              "description": "0表示任务提交成功，-1表示任务提交失败"
                            },
                            "height": {
                              "type": "number",
                              "description": "图片高度"
                            },
                            "call_back": {
                              "type": "string",
                              "description": "您设置的任务回调地址"
                            },
                            "prompt": {
                              "type": "string",
                              "description": "您的创作提示词"
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3041_1_POST",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "ext_app_params": {
                    "type": "object",
                    "description": "对单独应用的扩展参数。比如 二维码，房间设计，图片风格化等。类似这样的结构 ：\n{\n \"app_type\":\"qr_code\",\n \"ext_params\":{}\n}"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "创作提示词，建议使用英文，不用超过250个词"
                  },
                  "negetive_prompt": {
                    "type": "string",
                    "description": "反向提示词，不填则使用默认的"
                  },
                  "call_back": {
                    "type": "string",
                    "description": "任务完成时的回调地址，任务完成时会通过这个http地址推送结果，回调方式POST，payload格式为JSON，例{\"resList\":[...],\"task_id\":\"对应的任务id\"}"
                  },
                  "batch_size": {
                    "type": "number",
                    "description": "每个任务创作图片数量，支持1~4，默认为1，数字越大，调用时扣费越贵，任务花费时间也就越久"
                  },
                  "scale": {
                    "type": "number",
                    "description": "提示词的scale，范围在1~20之间， 默认3.5"
                  },
                  "seed": {
                    "type": "number",
                    "description": "随机种子数，范围在-1~4294967290之间，默认-1"
                  },
                  "width": {
                    "type": "number",
                    "description": "创作图片的宽度，width必须是8的倍数，最小512，最大1024，默认768"
                  },
                  "height": {
                    "type": "number",
                    "description": "创作图片的高度，height必须是8的倍数，最小512，最大1024，默认768"
                  },
                  "steps": {
                    "type": "number",
                    "description": "创作步骤数，最小5，最大50，默认5"
                  }
                },
                "required": [
                  "prompt"
                ]
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "AppKeyAuth": {
        "type": "apiKey",
        "in": "query",
        "name": "appKey",
        "description": "从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp"
      }
    },
    "schemas": {
      "ShowapiResEnvelope": {
        "type": "object",
        "description": "ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）",
        "properties": {
          "showapi_res_code": {
            "type": "integer",
            "description": "API 返回的状态码"
          },
          "showapi_res_error": {
            "type": "string",
            "description": "API 返回的错误信息"
          },
          "showapi_res_id": {
            "type": "string",
            "description": "API 请求的唯一标识"
          },
          "showapi_fee_num": {
            "type": "integer",
            "description": "API 调用计费次数"
          }
        }
      }
    }
  },
  "security": [
    {
      "AppKeyAuth": []
    }
  ],
  "externalDocs": {
    "url": "https://www.showapi.com/apiGateway/view/3041?tab=book"
  },
  "x-apiCode": "3041",
  "x-is-own": true,
  "x-is-op": true
}