{
  "openapi": "3.0.3",
  "info": {
    "title": "AI生成艺术二维码",
    "description": "它是一种使用AI技术来生成具有艺术风格的二维码图像生成接口。通过这个接口，将传统的黑白方块二维码转化为具有艺术气息的图像，具有一定的艺术性、创造性和趣味性。本接口提供内置的提示词，将二维码图片艺术化，可用于广告、品牌推广、艺术展览和景点导览等场景。",
    "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://route.showapi.com"
    }
  ],
  "paths": {
    "/3040-5": {
      "x-pointCode": 5,
      "x-mode": "mapping",
      "x-read-timeout": 5,
      "x-connect-timeout": 5,
      "post": {
        "summary": "二维码qr_format查询",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "ret_code": {
                              "type": "number"
                            },
                            "list": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "qr_format_url": {
                                    "type": "string",
                                    "description": "qr_format示例"
                                  },
                                  "qr_format": {
                                    "type": "string",
                                    "description": "支持的qr_format代码"
                                  }
                                }
                              }
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3040_5_POST",
        "parameters": []
      }
    },
    "/3040-3": {
      "x-pointCode": 3,
      "x-mode": "mapping",
      "x-read-timeout": 5,
      "x-connect-timeout": 5,
      "post": {
        "summary": "任务历史查询",
        "description": "AI生成艺术二维码api接口的历史任务局查询接入点可以查询您提交过的创作任务。",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "allPages": {
                              "type": "number"
                            },
                            "ret_code": {
                              "type": "number"
                            },
                            "contentlist": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "result_list": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    }
                                  },
                                  "qr_code_url": {
                                    "type": "string"
                                  },
                                  "text": {
                                    "type": "string"
                                  },
                                  "cause": {
                                    "type": "string"
                                  },
                                  "status": {
                                    "type": "string"
                                  },
                                  "task_id": {
                                    "type": "string"
                                  },
                                  "your_prompt": {
                                    "type": "string"
                                  },
                                  "batch_size": {
                                    "type": "string"
                                  },
                                  "ct": {
                                    "type": "string"
                                  },
                                  "verified_result": {
                                    "type": "boolean"
                                  },
                                  "style": {
                                    "type": "string"
                                  },
                                  "is_use_temp_short_link": {
                                    "type": "boolean"
                                  },
                                  "your_negetive_prompt": {
                                    "type": "string"
                                  },
                                  "short_link_life": {
                                    "type": "string"
                                  },
                                  "call_back": {
                                    "type": "string"
                                  }
                                }
                              }
                            },
                            "currentPage": {
                              "type": "number"
                            },
                            "allNum": {
                              "type": "number"
                            },
                            "maxResult": {
                              "type": "number"
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3040_3_POST",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "要查询的页码数，每页返回5个历史任务",
            "required": false,
            "schema": {
              "type": "number"
            }
          }
        ]
      }
    },
    "/3040-2": {
      "x-pointCode": 2,
      "x-mode": "mapping",
      "x-read-timeout": 5,
      "x-connect-timeout": 5,
      "post": {
        "summary": "任务进度查询",
        "description": "AI生成艺术二维码api接口的任务进度查询接入点可以通过任务id查询任务情况。",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "short_link_life": {
                              "type": "string",
                              "description": "我们提供的短链接有效期，目前有long（长期），temp（临时，一般为24小时），custom（未使用我们的短链接服务）"
                            },
                            "your_negetive_prompt": {
                              "type": "string",
                              "description": "您自定义的输入的负向提示词"
                            },
                            "your_prompt": {
                              "type": "string",
                              "description": "您自定义的提示词"
                            },
                            "verified_result": {
                              "type": "boolean",
                              "description": "是否对生成的二维码识别成功率进行过验证"
                            },
                            "qr_code_url": {
                              "type": "string",
                              "description": "您用URL入参的地址"
                            },
                            "ct": {
                              "type": "string",
                              "description": "任务创建时间"
                            },
                            "status": {
                              "type": "string",
                              "description": "任务状态有waiting，fail，finish"
                            },
                            "text": {
                              "type": "string",
                              "description": "您要编码的URL"
                            },
                            "call_back": {
                              "type": "string",
                              "description": "您提交的任务回调地址"
                            },
                            "batch_size": {
                              "type": "string",
                              "description": "创作二维码的数量"
                            },
                            "task_id": {
                              "type": "string",
                              "description": "任务id"
                            },
                            "style": {
                              "type": "string",
                              "description": "二维码风格id"
                            },
                            "cause": {
                              "type": "string",
                              "description": "任务失败原因"
                            },
                            "is_use_temp_short_link": {
                              "type": "boolean",
                              "description": "是否使用了我们的零时二维码服务"
                            },
                            "result_list": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              },
                              "description": "创建好的二维码结果列表，我们对创作好的二维码只保留24小时，请您及时保存结果"
                            },
                            "ret_code": {
                              "type": "number",
                              "description": "是否查询成功，0表示查询成功"
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3040_2_POST",
        "parameters": [
          {
            "name": "task_id",
            "in": "query",
            "description": "您要查询的任务id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/3040-1": {
      "x-pointCode": 1,
      "x-mode": "mapping",
      "x-read-timeout": 20,
      "x-connect-timeout": 5,
      "post": {
        "summary": "创建艺术二维码",
        "description": "我们的服务允许用户输入任何URL地址，并基于此信息生成具有独特艺术效果的二维码图片。您只需提供您希望转换的网址，我们的系统将自动处理，利用先进的算法和设计元素，为您创造一个既实用又美观的二维码。这些艺术化的二维码不仅能够满足基本的链接分享需求，还能作为视觉艺术品增添吸引力，适合用于营销材料、社交媒体分享、个人名片或任何需要结合技术实用性与创意设计的场合。",
        "responses": {
          "200": {
            "description": "成功响应",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ShowapiResEnvelope"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "showapi_res_body": {
                          "type": "object",
                          "properties": {
                            "qr_code_url": {
                              "type": "string",
                              "description": "源二维码链接"
                            },
                            "ret_code": {
                              "type": "number",
                              "description": "0表示任务提交成功，-1表示提交失败，一般为参数不符合要求"
                            },
                            "text": {
                              "type": "string",
                              "description": "二维码的编码文本"
                            },
                            "remark": {
                              "type": "string",
                              "description": "创作任务提交失败的原因"
                            },
                            "style": {
                              "type": "string",
                              "description": "二维码艺术风格id"
                            },
                            "status": {
                              "type": "string",
                              "description": "任务状态有waiting，fail，finish"
                            },
                            "task_id": {
                              "type": "string",
                              "description": "任务id"
                            },
                            "call_back": {
                              "type": "string",
                              "description": "您的回调地址"
                            },
                            "batch_size": {
                              "type": "string",
                              "description": "任务创作数量"
                            },
                            "ct": {
                              "type": "string",
                              "description": "任务生成时间"
                            }
                          },
                          "description": "业务返回体"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "operationId": "3040_1_POST",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string",
                    "description": "要生成二维码的文本信息，此处填写URL地址对应的字符串，建议此字符串不要超过25个字符。text和qr_code_url两个参数二选一，当两者都传入的时候，以text参数为准。"
                  },
                  "qr_code_url": {
                    "type": "string",
                    "description": "要艺术化的二维码图片地址，建议不要超过45个字符，二维码中字符数量越多，生成的二维码识别率越低。text和qr_code_url两个参数二选一，当两者都传入的时候，以text参数为准。"
                  },
                  "style_id": {
                    "type": "string",
                    "description": "创作使用的艺术风格id，支持的style_id请参考接口文档。"
                  },
                  "call_back": {
                    "type": "string",
                    "description": "任务的http回调地址，任务完成时会通过这个地址推送结果，回调方式POST，payload格式为JSON，例{\"resList\":[...],\"task_id\":\"对应的任务id\"}"
                  },
                  "batch_size": {
                    "type": "number",
                    "description": "每个任务创作的二维码数量，支持1~4，默认为1，数字越大，调用时扣费越贵，任务花费时间也就越久"
                  },
                  "your_prompt": {
                    "type": "string",
                    "description": "自定义提示词，支持中英文。为确保语义表达的准确性，请尽量使用英文。如使用中文，我们会翻译成英文后再生成二维码。注意：使用自定义提示词时，我们将尽可能的生成符合要求的二维码，但不保证二维码能被正常识别"
                  },
                  "use_short_link": {
                    "type": "number",
                    "description": "1表示使用短链接，0表示不使用短链接。超长URL地址若使用短链接，会极大提高生成后的二维码的识别率。此处生成的短链接只有24小时的有效期，仅为了方便查阅二维码的样式。如要长期使用该艺术二维码，请使用第三方的短链接服务生成相应短链接，然后再使用短链接生成艺术二维码（注意：短链接的有效期由您使用的第三方短链接服务决定）。"
                  },
                  "composition_ratio": {
                    "type": "string",
                    "description": "画面构图比例（宽:高）可选值： '1:1',\n    '3:4',\n    '4:3',\n    '16:9',\n    '9:16'"
                  },
                  "qr_code_base64": {
                    "type": "string",
                    "description": "二维码图片的base64字符串"
                  },
                  "position": {
                    "type": "string",
                    "description": "二维码在图中的位置，可选值\n'left',\n    'right',\n    'top',\n    'bottom',\n    'center'"
                  },
                  "qr_format": {
                    "type": "string",
                    "description": "二维码码形式，可选值：\nsquare\nsquare_re\nsquare_ex\ncolumn\ncolumn_re\ncolumn_ex\nrow\nrow_re\nrow_ex\nround\nround_re\nround_ex\nblock\nblock_re\nblock_ex\narc\narc_re\narc_ex"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "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/3040?tab=book"
  },
  "x-apiCode": "3040",
  "x-is-own": true,
  "x-is-op": true
}