Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clearmaas.com/llms.txt

Use this file to discover all available pages before exploring further.

GETFetch video task status

OpenAPI

/openapi.yaml get /video/generations/{task_id}
openapi: 3.1.0
info:
  title: ClearMaas API
  version: '2026.04'
  description: ClearMaas is an OpenAI-compatible API gateway.
  contact:
    name: ClearMaas Support
    email: support@clearmaas.com
    url: https://clearmaas.com
servers:
  - url: https://api.clearmaas.com/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /video/generations/{task_id}:
    get:
      tags:
        - Video
      summary: Fetch video task status
      operationId: fetchVideoTask
      parameters:
        - name: task_id
          in: path
          required: true
          schema:
            type: string
          example: task_9q9oz6tjtgABYWC1QIqoz3sscgVz7ycw
      responses:
        '200':
          description: Task state (wrapped envelope, uppercase status).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoFetchResponse'
components:
  schemas:
    VideoFetchResponse:
      type: object
      properties:
        code:
          type: string
          enum: [success]
        message:
          type: string
        data:
          type: object
          properties:
            task_id:
              type: string
            action:
              type: string
              enum: [textGenerate, generate, omniVideo]
              description: Resolved upstream endpoint variant.
            status:
              type: string
              enum: [NOT_START, SUBMITTED, IN_PROGRESS, SUCCESS, FAILURE, UNKNOWN]
              description: Raw task status (uppercase).
            progress:
              type: string
              description: Percent string, e.g. "30%", "100%".
            result_url:
              type: string
              description: Rendered MP4 URL. Present when status is SUCCESS.
            fail_reason:
              type: string
              description: Populated when status is FAILURE.
            submit_time:
              type: integer
            start_time:
              type: integer
            finish_time:
              type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key (sk-clearmaas-...)
      description: Pass `Authorization: Bearer sk-clearmaas-...` header.