众扬汇 AI 开放平台 API 文档

查询视频进度

OpenAPI Specification

yaml
openapi: 3.0.1
info:
  title: ''
  description: "本页接口说明详见下方接口定义;参数取值与返回以本平台实测为准。"
  version: 1.0.0
paths:
  /v1/videos/{task_id}:
    get:
      summary: 查询视频进度
      deprecated: false
      description: "本页接口「查询视频进度」对应 GET /v1/videos/{task_id},可按任务标识查看视频生成任务的当前进展。status 取值:queued、in_progress、completed、failed。该能力经第三方渠道对接,参数与返回以本平台实测为准。"
      tags:
        - 视频模型/Sora2官方格式
      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}}
      responses:
        '200':
          description: "该字段的取值与含义以本平台实际返回为准。"
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                '1':
                  summary: 进行中
                  value: "{\r\n    \"id\": \"video_9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11\",\r\n    \"object\": \"video\",\r\n    \"model\": \"sora-2-pro\",\r\n    \"status\": \"queued\", \\\\queued、in_progress、completed、failed\r\n    \"progress\": 0,\r\n    \"created_at\": 1785000000,\r\n    \"seconds\": \"15\",\r\n    \"size\": \"1280x720\",\r\n    \"error\": null,\r\n    \"video_url\": \"\" // 成功时,会生成视频链接,也可以通过openai 格式接口获取视频\r\n}"
                '2':
                  summary: 失败
                  value:
                    id: sora-2:task_9c1e0a2b7d44
                    status: failed
                    created_at: 1785000000000
                    model: sora-2
                    object: video
                    progress: 0
                    seconds: '10'
                    size: small
                    error:
                      code: generation_failed
                      message: >-
                        This content may violate our guardrails concerning
                        similarity to third-party content.
                '3':
                  summary: 完成
                  value:
                    id: sora-2:task_9c1e0a2b7d44
                    status: completed
                    created_at: 1785000000000
                    model: sora-2
                    object: video
                    progress: 100
                    seconds: '15'
                    size: small
                    url: >-
                      https://files.example.com/cdn/20251017/9f2c1a4b7d0e5a83.mp4
                    video_url: >-
                      https://files.example.com/cdn/20251017/9f2c1a4b7d0e5a83.mp4
          headers: {}
      security: []
components:
  schemas: {}
  securitySchemes: {}
servers: []
security: []

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

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