Meshy Animation API Documentation

Meshy Animation API Documentation

Playground

Meshy Animation rigs a character model and applies up to 10 animations from the Meshy library. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

Meshy Animation rigs a 3D character and applies preset animations in a single workflow. Choose the character skeleton type, set its approximate height, and apply up to 10 animation actions to the final rigged model.

Why Choose This?

• Automatic character rigging — Add a skeleton and skinning to a character model.
• Biped and quadruped support — Choose the skeleton type that matches the character.
• Multiple animations — Apply up to 10 preset animation actions in one request.
• Height control — Set the character’s approximate height for more accurate rigging.
• Multi-clip output — Include multiple animation clips in the resulting animated model.

Parameters

How to Use

1. Upload a character model — Provide the source 3D character.
2. Choose the skeleton type — Select biped or quadruped.
3. Set the character height optional — Adjust height_meters when needed.
4. Choose animations — Add between 1 and 10 animation IDs.
5. Submit — Rig the character and retrieve the animated model.

Pricing

Pricing includes $0.20 for character rigging plus $0.12 for each requested animation.

Skeleton type and character height do not add separate charges.

Best Use Cases

• Game characters — Prepare animated characters for real-time projects.
• Character prototyping — Quickly rig and preview movement on a new 3D character.
• Animation libraries — Add several reusable actions to one character model.
• Interactive applications — Prepare multiple clips for character state and behavior systems.
• 3D content production — Create rigged and animated assets for downstream editing.

Pro Tips

• Use a character with clearly defined limbs and body structure.
• A neutral A-pose or T-pose generally provides better rigging results.
• Choose animation_type to match the character’s body structure.
• Set an approximate real-world height for more accurate rigging.
• Select animation IDs that are appropriate for the chosen skeleton type.
• Keep the source mesh reasonably clean before rigging.

Notes

• model is required.
• animation_type defaults to biped.
• height_meters defaults to 1.7.
• action_ids supports between 1 and 10 animation IDs.
• Duplicate animation IDs should not be used.
• action_ids defaults to ["92"].
• Each requested animation adds a separate animation clip to the output.
• Multiple requested animations are included together in the animated model.
• Use animation IDs compatible with the selected skeleton type.

Authentication

For authentication details, please refer to the Authentication Guide.

API Endpoints

Submit Task & Query Result

set -euo pipefail

export WAVESPEED_API_KEY="your-api-key"

REQUEST_BODY=$(cat <<'JSON'
{
  "model": "example",
  "animation_type": "biped",
  "height_meters": 1.7,
  "action_ids": [
    "92"
  ]
}
JSON
)

# 1. Submit the prediction once. Never retry this request automatically:
# a retry after an unclear failure can create a second, billed task.
CHECK='The task may already exist. Check History or the predictions list before submitting again.'
if ! SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --connect-timeout 10 --max-time 60 \
  -X POST "https://api.wavespeed.ai/api/v3/meshy/animation" \
  -H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  -H "Content-Type: application/json" \
  -d "${REQUEST_BODY}"); then
  printf 'Submit failed. %s\n' "${CHECK}" >&2
  exit 1
fi

TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
  printf 'Submission response did not contain a prediction id. %s\n' "${CHECK}" >&2
  exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"

# 2. Poll until the prediction reaches a final status.
BODY_FILE=$(mktemp)
trap 'rm -f "${BODY_FILE}"' EXIT
while true; do
  # Transient errors (429, 5xx) are retried, honoring Retry-After.
  HTTP_CODE=$(curl --silent --show-error --fail-with-body \
    --connect-timeout 10 --max-time 60 --retry 5 --retry-delay 2 \
    --output "${BODY_FILE}" --write-out '%{http_code}' \
    "${RESULT_URL}" \
    -H "Authorization: Bearer ${WAVESPEED_API_KEY}" || true)
  case "${HTTP_CODE}" in
    2??) ;;
    000|429|5??)  # dropped connection or temporary error: keep polling
      printf 'Task %s: HTTP %s, polling again in 10s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
      sleep 10; continue ;;
    *) printf 'Task %s: HTTP %s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
      cat "${BODY_FILE}" >&2; exit 1 ;;
  esac
  RESULT=$(jq 'if type == "object" and has("data") then .data else . end' "${BODY_FILE}")
  STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')

  case "${STATUS}" in
    completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
    failed|cancelled|timeout|deleted)
      printf 'Task %s ended with status %s\n' "${PREDICTION_ID}" "${STATUS}" >&2
      printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
    *) sleep 2 ;;
  esac
done

Parameters

Task Submission Parameters

Request Parameters

Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.

Response Parameters

Result Request Parameters

Result Response Parameters