众扬汇 AI 开放平台 API 文档

获取任务进度、结果(免费

OpenAPI Specification

yaml
openapi: 3.0.1
info:
  title: ''
  description: "本页接口说明详见下方接口定义;参数取值与返回以本平台实测为准。"
  version: 1.0.0
paths:
  /pro/viggle/video-task/by-ids:
    post:
      summary: 获取任务进度、结果(免费
      deprecated: false
      description: "ids 即 taskID,当前只接受一项;多传时仅取第一项的结果。状态码对应:“0“ 表示 SUCCESS、“2“ 表示 FAILURE、“3“ 表示 IN_PROGRESS。"
      tags:
        - 废弃、未开放/Viggle 舞蹈合成
      parameters:
        - name: content-type
          in: header
          description: "该字段的取值与含义以本平台实际返回为准。"
          required: true
          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}}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: string
              required:
                - ids
            examples: {}
      responses:
        '200':
          description: "该字段的取值与含义以本平台实际返回为准。"
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example:
                code: 0
                message: ok
                ts: ''
                reason: ''
                data:
                  - taskID: 9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11
                    name: Diulio Sephus1785000000
                    status: 0
                    image:
                      id: 9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11
                      name: 163-q
                      url: >-
                        https://files.example.com/image-asset/9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA34TJNLFYRSUCDEUH%2F20240705%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240705T153136Z&X-Amz-Expires=43200&X-Amz-SignedHeaders=host&X-Amz-Signature=9f2c1a4b7d0e5a83
                      width: 0
                      height: 0
                    template:
                      id: 9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11
                      command: rickroll_never_gonna_give_you_up
                      webCommand: Rickroll Never Gonna Give You Up
                      description: "(示例歌词片段,与实际生成结果无关)"
                      webStatus: 0
                      dcStatus: 0
                      appStatus: 0
                      processedURL: >-
                        https://files.example.com/template/9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.mp4
                      processedHdURL: ''
                      processedCoverURL: >-
                        https://files.example.com/web-template/1785000000000-9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.jpg
                      bgURL: ''
                      bgCoverURL: ''
                      displayURL: >-
                        https://files.example.com/template/9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.mp4
                      displayHdURL: ''
                      displayCoverURL: >-
                        https://files.example.com/web-template/1785000000000-9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.jpg
                      gifURL: >-
                        https://files.example.com/web-template/1785000000000-9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.gif
                      webPURL: >-
                        https://files.example.com/web-template/1785000000000-9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.webp
                      source: 'YouTube: Rick Astley'
                      sort: 0
                      width: 1280
                      height: 960
                    videoDuration: 6.64
                    bgMode: 2
                    modelInfoID: 3
                    optimize: true
                    watermark: 0
                    freeCredits: 0
                    planCredits: 0
                    purchasedCredits: 0
                    mqType: 0
                    result: >-
                      https://files.example.com/gras/9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.mp4
                    resultCover: >-
                      https://files.example.com/web-template/1785000000000-9c1e0a2b-7d44-4f10-9a53-2b1c8e6d0f11.jpg
                    createdAt: '2024-07-05T15:25:30.034Z'
          headers: {}
      security: []
components:
  schemas: {}
  securitySchemes: {}
servers: []
security: []

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

该分组标记为「废弃 / 未开放」,接入前请先与对接人确认开放状态。