Generate

Animate a mascot from a reference video

From Video uses Premium to transfer reference motion to your mascot. Upload a video and its first frame through POST /v1/upload, then provide their asset IDs. Source assets must be completed, active, and accessible to the credential; collection assets must belong to its workspace. Creates one animation item plus start and end pose items, with MP4, transparent WebM/HEVC, and pose images. Costs 6 credits per output second plus 1 image credit, so the default 5s costs 31 credits. Output duration is 4–30 whole seconds. Standard is not supported for this operation. Returns 202; poll the returned job until completed. Do not resubmit while the job is running.

post/v1/collections/{id}/animations/reference-video

Request

  • Base URL: https://api.masko.ai
  • URL: https://api.masko.ai/v1/collections/{id}/animations/reference-video
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Account-scoped key (1 to 255 characters, ideally a UUID). Retries must preserve the credential workspace, effective API version, URL, content type and exact body bytes, including multipart boundaries; different inputs return 409 idempotency_key_reused. Completed responses, including 500 errors, replay for 24 hours after completion with current resource access checked again. Running or unconfirmed executions return 409 idempotency_request_in_progress and do not expire automatically. A receipt persistence failure returns 503 idempotency_persistence_failed: retry only with the same key and inspect the operation outcome before starting a new request.

Request body

video_asset_idstring uuid required

Owned, completed video asset containing the reference motion. Upload an MP4 or WebM with POST /v1/upload first.

first_frame_asset_idstring uuid required

Owned, completed image asset showing the first frame of the reference video. Upload it with POST /v1/upload.

namestring required

Name for the animation. Start and end pose items are also created.

promptstring

Optional instructions for the mascot pose and appearance.

durationinteger

Output duration in whole seconds, 4–30. Default 5. Premium costs 6 credits/sec plus 1 image credit.

animation_model'premium'

From Video always uses Premium. Standard is available for image-to-video animation through /generate.

variant_idstring uuid

Optional approved mascot variant to animate.

context_asset_idstring uuid

Optional asset in this collection whose saved mascot context is reused when variant_id is omitted.

Response

Reference video job started

Changes

No recorded changes to this operation across all 2 revisions of this API.