Generate

Animate an uploaded image

Animate a completed image without generating another pose. Send either mascot_id to reuse an existing mascot, or create_mascot: {project_id, name?} to explicitly create one from an unattached upload in the same request. Omit create_mascot.name for an AI-chosen character name; no character description is generated. Returns mascot_id, mascot_name and mascot_created alongside the normal job receipt. Reuse mascot_id for subsequent animations to avoid creating extra mascots. Non-square inputs are center-cropped to square before animation; source_image_crop overrides framing. Originals are preserved. Only animation credits are charged: Standard (default) 2/sec, Premium 6/sec, default 5 seconds. Use Idempotency-Key to retry the complete operation without creating another mascot or job. If generation fails after mascot creation, error.details.mascot_id identifies the saved mascot; reuse it in a corrected request with a new key. This endpoint uses the canonical mascot API contract automatically.

post/v1/animations

Request

  • Base URL: https://api.masko.ai
  • URL: https://api.masko.ai/v1/animations
  • Auth: HTTP bearer

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

source_image_asset_idstring uuid required

Completed image to animate. For a new mascot, use an unattached image from POST /v1/upload.

mascot_idstring uuid

Save under this existing mascot. Reuse the ID returned by your first request.

variant_idstring uuid
namestring

Animation action name, separate from the mascot name.

animation_promptstring required
animation_model'standard' | 'premium'

Standard: 2 credits/sec, 2–15 seconds. Premium: 6 credits/sec, 4–30 seconds. Defaults to Standard.

durationinteger
loopboolean

Response

Animation accepted

Changes

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