Public API

Create Video Generation

post/v1/video-generations

Request

  • Base URL: https://api.animgen.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.animgen.com/v1/video-generations
  • Auth: HTTP bearer

Headers

Idempotency-Keystring nullable

Request body

promptstring

Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs.

negative_promptstring

Optional exclusions, only when the model supports negative prompts.

metadataobject

Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets.

Response

Successful Response

idstring uuid required

Persist this task ID immediately after create; poll it instead of creating again.

object'video_generation' | 'animation_export' | 'animation' required

Public task resource type.

status'queued' | 'running' | 'cancelling' | 'succeeded' | 'failed' | 'cancelled' required

succeeded, failed, and cancelled are terminal; cancelling is not terminal.

stage'queued' | 'video_generation' | 'animation_export' | 'completed' nullable

Current pipeline stage when available.

progressnumber required

Fraction from 0 to 1, not a completion-time estimate.

metadataobject

Caller-provided metadata.

normalized_inputobject

Normalized public input; may contain private prompts or image references. Do not log wholesale.

created_atstring date-time required

UTC acceptance timestamp.

started_atstring date-time nullable

UTC production start when known.

finished_atstring date-time nullable

UTC terminal timestamp when known.

Changes

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