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.

POSTSubmit a video task

OpenAPI

/openapi.yaml post /video/generations
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:
    post:
      tags:
        - Video
      summary: Submit a video task
      operationId: createVideoTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoGenerationRequest'
      responses:
        '200':
          description: Task accepted (async — poll /v1/video/generations/{task_id})
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoSubmitResponse'
components:
  schemas:
    VideoGenerationRequest:
      type: object
      required:
        - model
        - prompt
      properties:
        model:
          type: string
          description: Kling video model with kling/ namespace prefix.
          example: kling/kling-v3-omni
          enum:
            - kling/kling-v2-master
            - kling/kling-v2-1-master
            - kling/kling-v2-5-turbo
            - kling/kling-v2-6
            - kling/kling-v3
            - kling/kling-video-o1
            - kling/kling-v3-omni
        prompt:
          type: string
          description: Required. Kling rejects empty/whitespace-only prompts.
        image:
          type: string
          description: Optional first-frame image URL for image-to-video.
        metadata:
          type: object
          description: |
            Free-form parameter bag. Universal: mode (std/pro/4k), aspect_ratio (16:9/9:16/1:1), duration (seconds).
            Text/i2v only: negative_prompt, cfg_scale, image_tail.
            Omni only: image_list, video_list, multi_shot, shot_type, multi_prompt, sound, watermark_info.
          additionalProperties: true
    VideoSubmitResponse:
      type: object
      properties:
        id:
          type: string
          description: Task ID. Same as task_id.
        task_id:
          type: string
        object:
          type: string
          enum: [video]
        model:
          type: string
        status:
          type: string
          enum: [queued]
        progress:
          type: integer
          minimum: 0
          maximum: 100
        created_at:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key (sk-clearmaas-...)
      description: Pass `Authorization: Bearer sk-clearmaas-...` header.