> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inputapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve video task

> Request format, responses, and capability boundaries.

`GET /v1/videos/{task_id}`

`task_id` is the gateway `id` returned by creation. Use credentials in the same user/project scope. Missing or inaccessible tasks can return 400 rather than always 404.

Wait for `queued` / `in_progress`, download on `completed`, and stop automation on `failed` / `unknown`. Snapshots may lag upstream; `progress` does not replace `status`. Plugins may preserve extra fields; a provider-specific `url` is not universally present.

[Integration guide and runnable example](/en/guides/video-generation)

[简体中文](/zh/api-reference/videos-retrieve)


## OpenAPI

````yaml openapi/relay.json GET /v1/videos/{task_id}
openapi: 3.0.3
info:
  title: API — Core inference API
  version: 0.5.0
  description: >-
    面向接入的精选规范，不是全部管理或供应商接口。 / Curated integration specification, not the entire
    management or provider API.
  license:
    name: AGPL-3.0-or-later
servers:
  - url: https://gateway.example.com
    description: >-
      Example only; replace with your gateway origin and optional path prefix,
      without /v1.
security:
  - BearerAuth: []
paths:
  /v1/videos/{task_id}:
    get:
      summary: 查询视频任务 / Retrieve video task
      description: >-
        常用接入字段；能力取决于模型、渠道与部署。 / Common integration fields; support depends on
        the model, channel, and deployment.
      operationId: GETVideosRetrieve
      parameters:
        - name: task_id
          in: path
          required: true
          schema:
            type: string
          description: >-
            同一用户/项目范围内的网关公开 ID / Public gateway ID in the same user/project
            scope
      responses:
        '200':
          description: 任务快照，可能尚未更新到最新上游状态 / Task snapshot; may lag upstream state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Video'
              example:
                id: task_example
                object: video
                model: YOUR_MODEL_ID
                status: queued
                progress: 0
                created_at: 1700000000
        '400':
          description: 请求参数错误 / Invalid request
        '401':
          description: 身份校验失败 / Authentication failed
        '403':
          description: 访问被拒绝 / Access denied
        '404':
          description: 接口或资源不存在 / Endpoint or resource not found
        '410':
          description: 内容已不可用 / Content no longer available
        '429':
          description: 请求被限流或受配额限制 / Rate or quota restriction
        '500':
          description: 网关或上游错误 / Gateway or upstream error
        '502':
          description: 内容代理或上游失败 / Content proxy or upstream failure
        '503':
          description: 服务暂不可用 / Service unavailable
        default:
          description: 其他网关或上游错误；格式可能不同 / Other gateway or upstream error; shape may vary
components:
  schemas:
    Video:
      type: object
      properties:
        id:
          type: string
          description: >-
            网关公开任务 ID，后续查询/下载使用此值 / Public gateway task ID; use for
            retrieval/download
          example: task_example
        object:
          type: string
          example: video
        model:
          type: string
          description: >-
            当前密钥可用且支持此接口的模型 ID / Model ID available to the key and supporting
            this endpoint
          example: YOUR_MODEL_ID
        status:
          type: string
          description: >-
            以状态判断完成；unknown 必须单独处理 / Determine completion from status; handle
            unknown separately
          enum:
            - queued
            - in_progress
            - completed
            - failed
            - unknown
        progress:
          type: integer
          description: 进度提示，不等同于完成保证 / Progress hint, not proof of completion
        created_at:
          type: integer
          description: Unix 秒 / Unix seconds
        completed_at:
          type: integer
          description: 完成时间，可省略 / Completion timestamp; may be omitted
        expires_at:
          type: integer
          description: 渠道可能提供的过期时间 / Optional expiry from channel
        seconds:
          type: string
        size:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
        metadata:
          type: object
      required:
        - id
        - object
        - model
        - status
        - progress
        - created_at
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 模型调用 API Key，不是控制台登录凭据 / Model API key, not console login credentials

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.