众扬汇 AI 开放平台 API 文档

获取任务状态

OpenAPI Specification

yaml
openapi: 3.0.1
info:
  title: ''
  description: "本页接口说明详见下方接口定义;参数取值与返回以本平台实测为准。"
  version: 1.0.0
paths:
  /higgsfield/feed/{task_id}:
    post:
      summary: 获取任务状态
      deprecated: false
      description: "HIGGSFIELD.2 · 视频任务状态查询"
      tags:
        - 视频模型/Higgsfield
      parameters:
        - name: task_id
          in: path
          description: "本任务的标识,提交时由平台下发;后续查状态需带上它"
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: "该字段的取值与含义以本平台实际返回为准。"
          required: false
          example: Bearer {{YOUR_API_KEY}}
          schema:
            type: string
            default: Bearer {{YOUR_API_KEY}}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - task_id
              properties:
                task_id:
                  type: string
                  description: "取自创建任务那一步的返回值"
            examples: {}
      responses:
        '200':
          description: "该字段的取值与含义以本平台实际返回为准。"
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: "本次操作的标识,由平台生成"
                  type:
                    type: string
                    description: "任务所属类型"
                  project_id:
                    type: string
                  created_at:
                    type: number
                    description: "任务创建时间戳"
                  params:
                    type: object
                    description: "本次任务使用的参数"
                    properties: {}
                  jobs:
                    type: array
                    description: "任务执行情况"
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        status:
                          type: string
                          description: "任务状态,可能取值:queued、in_progress、completed"
                          enum:
                            - queued
                            - in_progress
                            - completed
                        result:
                          type: object
                          properties:
                            type:
                              type: string
                            url:
                              type: string
                              description: "生成视频的访问地址"
          headers: {}
      security: []
components:
  schemas: {}
  securitySchemes: {}
servers: []
security: []

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

模型名请在「模型广场」复制后填入,不要手输;计费、限流与在售清单以平台实测为准(部分数值待补)。