---
title: "Video Generate Api"
method: POST
path: "/v1/video/generate"
tags: ["Video"]
---

# Video Generate Api

`POST /v1/video/generate`

Generate an animation asynchronously

## Request body

- ImageVideoRequest
  - `output` string, uri — Customize the result output.
  - `input` string, uri, required — URL of the input image. Image must be accessible by our system.
  - `options` VideoOptionsObject, required
    - `prompt` union, required — Prompt for the video.
      - string
      - VideoPromptObject
        - `text` string — Prompt for the video.
        - `generate` boolean — If `true`, the prompt will be generated automatically based on the input image.By default, the prompt is not auto-generated. If `true`, the `text` is not allowed.
        - `guidelines` string — Guidelines for prompt generation. Only available when `generate` is `true`.
    - `negative_prompt` string — Negative prompt for the video.
    - `duration` '5' | '10' — An enumeration.
    - `guidance_scale` number — Guidance scale for the video.

## Response `200`

Successful Response

- ResponseVideoAcceptedResponse — Wrapper for responses
  - `data` VideoAcceptedResponse
    - `id` integer, required
    - `status` 'ACCEPTED' | 'WAITING' | 'PROCESSING' | 'DONE' | 'ERROR' | 'CANCELLED' | 'PAUSED', required — An enumeration.
    - `created_at` string, date-time, required
    - `request` VideoRequestInResponse, required
      - `output` string, uri — Customize the result output.
      - `input` string, uri, required — URL of the input image. Image must be accessible by our system.
      - `options` VideoOptionsObject, required
        - `prompt` union, required — Prompt for the video.
          - string
          - VideoPromptObject
            - `text` string — Prompt for the video.
            - `generate` boolean — If `true`, the prompt will be generated automatically based on the input image.By default, the prompt is not auto-generated. If `true`, the `text` is not allowed.
            - `guidelines` string — Guidelines for prompt generation. Only available when `generate` is `true`.
        - `negative_prompt` string — Negative prompt for the video.
        - `duration` '5' | '10' — An enumeration.
        - `guidance_scale` number — Guidance scale for the video.
    - `result_url` string, uri, required

## Other responses

- `401` — Authorization is required.
- `402` — No API calls left.
- `403` — Not enough permissions.
- `422` — Unprocessable Entity.
- `429` — Too many requests.

---

[API](https://skmtc.net/claid/apis/claid-rest-api.md) · [All operations](https://skmtc.net/claid/apis/claid-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/claid/claid-rest-api/revisions/410fc0db9665/schema)
