Skip to main content
POST
Start model rigging and animation

Authorizations

Authorization
string
header
required

Mint API key sent as a Bearer token.

Headers

Idempotency-Key
string

Optional stable key for safely retrying an uncertain mutating request. Mint creates an internal key when this header is omitted. Reusing a supplied key with different parameters returns 409.

Required string length: 1 - 255

Path Parameters

modelId
string
required

Body

application/json

Animation selection and optional sizing for one eligible Mint 3D Model.

animationSetId
string
required

Stable curated set ID from GET /v1/animation-sets. Include animationActionIds to select a subset of that set.

motionPrompt
string

Describe the motion Mint should select; do not combine with animationSetId.

Required string length: 1 - 2000
animationActionIds
integer[]

Optional subset of curated action IDs from the selected animationSetId.

Required array length: 1 - 10 elements
Required range: 0 <= x <= 696
heightMeters
number

Character height in meters used to scale the animation result.

Required range: 0.5 <= x <= 3

Response

An earlier request with the same retry key returned this operation.

A long-running operation acting on one Mint animation.

object
string
required

Stable object discriminator.

Allowed value: "operation"
id
string
required

Mint operation ID used for polling.

type
enum<string>
required

The work this operation performs.

Available options:
model_animation
generationMode
enum<string>
required

Workflow mode for this operation.

Available options:
auto,
review
status
enum<string>
required

Current operation lifecycle status.

Available options:
queued,
running,
preview_ready,
billing_required,
succeeded,
partially_succeeded,
failed,
canceled
resource
object
required

The Mint animation affected by this operation.

createdAt
string<date-time>
required

When the operation was created.

updatedAt
string<date-time>
required

When the operation last changed.

billing
object

The billing action required before this operation can continue.

credits
object

Credit estimate, active reservation, finalized charge, and post-reservation balance for this operation.

error
object

Terminal failure details when the operation failed.

completedAt
string<date-time>

When the operation completed.

canceledAt
string<date-time>

When the operation was canceled.