Generation

Create a video generation task

Validates the request, charges credits, and submits the job before responding; the video renders asynchronously. Poll GET /api/v1/tasks/{taskId}. Omitted duration, resolution and aspect_ratio take modes.<mode>.defaults from GET /api/v1/models before pricing.

post/api/v1/videos

Request

  • Base URL: https://viewmax.studio
  • URL: https://viewmax.studio/api/v1/videos
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional. 1–200 visible ASCII characters, no spaces (otherwise 400). A repeated key for the same account, on any create endpoint, returns the task the first request created with its original costCredits and charges nothing; the body is not compared. Without it, every request creates and charges a new task.

Request body

modelstring required

Model id from GET /api/v1/models. Offline models return 400 video model temporarily unavailable: <id>. ....

promptstring required

Trimmed. At most the model's max_prompt_length characters when the catalog lists one (minimax-h3: 7000).

mode'text-to-video' | 'image-to-video' | 'video-to-video' | 'frames-to-video' | 'reference-to-video'

Must be a key of the model's modes. Default: image-to-video when image_urls is non-empty, else video-to-video when video_urls is non-empty, else text-to-video.

image_urlsstring[]

http(s) URLs the provider can fetch without authentication. image-to-video: 1 (some models 2); frames-to-video: 2 (start, end); reference-to-video: 1 or more. Per-model maximums are in the docs.

video_urlsstring[]

One source video. Required for video-to-video; optional for reference-to-video on Seedance 2.0, 2.0 Fast, 2 Mini and MiniMax H3.

Response

Task created, or the existing task for a repeated Idempotency-Key.

code0 required
message'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.