众扬汇 AI 开放平台 API 文档

获取请求状态

OpenAPI Specification

yaml
openapi: 3.0.1
info:
  title: ''
  description: "本页接口说明详见下方接口定义;参数取值与返回以本平台实测为准。"
  version: 1.0.0
paths:
  /{platform}/model_name/requests/request_id/status:
    get:
      summary: 获取请求状态
      deprecated: false
      description: "本页为 Fal.ai 兼容格式的请求状态查询接口。Queue 的 status 与属性:IN_QUEUE(queue_position 任务在队列中的位置、response_url 处理完成后响应可用的地址)、IN_PROGRESS(logs 与请求相关的日志数组,需先开启)。实际取值以本平台返回为准。"
      tags:
        - Fal.ai 平台兼容
      parameters:
        - name: platform
          in: path
          description: "该字段的取值与含义以本平台实际返回为准。"
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: "该字段的取值与含义以本平台实际返回为准。"
          required: false
          example: application/json
          schema:
            type: string
        - name: Authorization
          in: header
          description: "该字段的取值与含义以本平台实际返回为准。"
          required: false
          example: Bearer {{YOUR_API_KEY}}
          schema:
            type: string
            default: Bearer {{YOUR_API_KEY}}
      responses:
        '200':
          description: "该字段的取值与含义以本平台实际返回为准。"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  queue_position:
                    type: integer
                  response_url:
                    type: string
                required:
                  - status
                  - queue_position
                  - response_url
              example:
                status: IN_QUEUE
                queue_position: 0
                response_url: >-
                  https://api.example.com/fal-ai/fast-sdxl/requests/9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11
          headers: {}
      security: []
components:
  schemas: {}
  securitySchemes: {}
servers: []
security: []

使用提示:本页接口的 Base URL 为 https://api.allyang.cn,请求头需携带 Authorization: Bearer <令牌>(令牌在控制台「令牌管理」中创建)。示例中的任务 ID、时间戳与文件地址均为示意值,实际以平台返回为准。

本页为聚合平台兼容格式,模型可用性与计费以本平台「模型广场」公布为准。