API de Animação

Endpoints para descobrir animações disponíveis e aplicá-las a personagens com rig.

POST/openapi/v1/animations

Create an Animation Task

Este endpoint permite criar uma nova tarefa para aplicar uma animação a um personagem previamente rigged — seja uma ação predefinida da biblioteca de animações (action_id) ou um clipe de movimento gerado com a Text to Motion API (motion_task_id). Inclui opções de pós-processamento.

Parâmetros

Name
rig_task_id
Type
string
Obrigatório
Description
O id de uma tarefa de rigging concluída com sucesso (de POST /openapi/v1/rigging). O personagem dessa tarefa será animado.
Name
action_id
Type
integer
Description
O identificador da ação de animação predefinida a ser aplicada. Consulte a Referência da Biblioteca de animações para obter uma lista completa das animações disponíveis. Forneça exatamente um entre action_id ou motion_task_id.
Name
motion_task_id
Type
string
Description
O id de uma tarefa de Text to Motion concluída com sucesso a ser aplicada em vez de uma ação predefinida. O clipe gerado é retargeted para o personagem rigged e o clipe é capturado (snapshot) no momento da criação, portanto essa tarefa não é afetada caso a tarefa de origem expire ou seja excluída posteriormente. Os assets da tarefa de origem são mantidos por 3 dias — aplique o clipe antes que ele expire. Requer um rig bípede. Forneça exatamente um entre action_id ou motion_task_id.
Name
post_process
Type
object
Description
Pós-processamento opcional para a saída da animação. Omita para receber os arquivos de animação padrão.

Aplica-se somente quando post_process is set

Name
operation_type
Type
string
Obrigatório
Description
O tipo de operação a ser executada. Valores disponíveis: change_fps, fbx2usdz, extract_armature.
Name
fps
Type
integer
padrão 30
Description
A taxa de quadros de destino. Aplicável apenas quando operation_type é change_fps. Valores permitidos: 24, 25, 30, 60.

Com motion_task_id, o retargeting pode produzir uma animação apenas em GLB. Se você solicitou post_process e nenhum FBX estiver disponível, a tarefa falha com um task_error e seus créditos são reembolsados automaticamente; sem post_process, a tarefa é concluída com sucesso e animation_fbx_url fica vazio.

Retornos

A propriedade result da resposta contém o id da tarefa da nova tarefa de animação criada.

Modos de falha

Name
400 - Bad Request
Description
A solicitação era inaceitável. Causas comuns:
- Parâmetro ausente: rig_task_id está ausente, ou nem action_id nem motion_task_id foram fornecidos.
- Parâmetros conflitantes: tanto action_id quanto motion_task_id foram fornecidos — eles são mutuamente exclusivos.
- Tarefa de rig inválida: O rig_task_id é inválido ou refere-se a uma tarefa com falha/inexistente.
- ID de ação inválido: O action_id não corresponde a uma animação válida.
- Tarefa de movimento não pronta: a tarefa motion_task_id ainda não teve SUCCEEDED.
- Rig não suportado: motion_task_id requer um rig bípede; rigs quadrúpedes são rejeitados.
Name
401 - Unauthorized
Description
Falha na autenticação. Verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para executar essa tarefa.
Name
404 - Not Found
Description
A tarefa de rigging especificada por rig_task_id não foi encontrada, a tarefa de movimento especificada por motion_task_id não foi encontrada, ou o clipe de movimento expirou (os assets da tarefa de origem são mantidos por 3 dias).
Name
429 - Too Many Requests
Description
Você excedeu seu limite de taxa.

Request

POST

/openapi/v1/animations

# Animate a rigged model with required params only
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92
  }'

# Apply a generated Text to Motion clip instead of a preset action
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "motion_task_id": "018c425b-b2c6-727e-d333-3c1887i9h791"
  }'

# With post-processing to change FPS
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92,
    "post_process": {
      "operation_type": "change_fps",
      "fps": 24
    }
  }'

Response

{
  "result": "018c425b-b2c6-727e-d333-3c1887i9h791"
}

GET/openapi/v1/animations/:id

Recuperar uma Tarefa de Animação

Este endpoint permite recuperar uma tarefa de animação a partir de um id de tarefa válido. Consulte O Objeto de Tarefa de Animação para ver quais propriedades estão incluídas.

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de animação a ser recuperada.

Retornos

A resposta contém o objeto de Tarefa de Animação. Consulte a seção O Objeto de Tarefa de Animação para mais detalhes.

Request

GET

/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791

curl https://api.meshy.ai/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791 
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.glb?Expires=...",
    "animation_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.fbx?Expires=...",
    "processed_usdz_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed.usdz?Expires=...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_armature.fbx?Expires=...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_60fps.fbx?Expires=..."
  },
  "preceding_tasks": 0
}

DELETE/openapi/v1/animations/:id

Excluir uma Tarefa de Animação

Este endpoint exclui permanentemente uma tarefa de animação, incluindo todos os modelos e dados associados. Essa ação é irreversível.

Parâmetros de Caminho

Name
id
Type
path
Description
O ID da tarefa de animação a ser excluída.

Retornos

Retorna 200 OK em caso de sucesso.

Request

DELETE

/openapi/v1/animations/018b314a-a1b5-716d-c222-2f1776f7f579

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/animations/018b314a-a1b5-716d-c222-2f1776f7f579 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/animations

Listar Tarefas de Animação

Retorna uma lista paginada das tarefas de animação do solicitante, das mais recentes para as mais antigas. Paginação padrão via page_num e page_size.

Observe que as tarefas criadas por meio da API são gerenciadas por meio da API — elas não aparecem em Meus Assets no aplicativo web. Use este endpoint para encontrar uma tarefa cujo ID você não tem mais.

Request

GET

/openapi/v1/animations

curl "https://api.meshy.ai/openapi/v1/animations?page_num=1&page_size=20" \
-H "Authorization: Bearer ${YOUR_API_KEY}"

GET/openapi/v1/animations/:id/stream

Transmitir uma Tarefa de Animação

Este endpoint transmite atualizações em tempo real para uma tarefa de Animação usando Server-Sent Events (SSE).

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de Animação a ser transmitida.

Retornos

Retorna um fluxo de The Animation Task Objects como Server-Sent Events.

Para tarefas PENDING ou IN_PROGRESS, o fluxo de resposta incluirá apenas os campos progress e status necessários.

Request

GET

/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791/stream

curl -N https://api.meshy.ai/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791/stream 
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: { // Example of a SUCCEEDED task stream item, mirroring The Animation Task Object structure
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.glb?...",
    "animation_fbx_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.fbx?...",
    "processed_usdz_url": "https://assets.meshy.ai/.../processed.usdz?...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/.../processed_armature.fbx?...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/.../processed_60fps.fbx?..."
  },
  "preceding_tasks": 0
}

O Objeto de Tarefa de Animação

O objeto de Tarefa de Animação representa a unidade de trabalho para aplicar uma animação a um personagem com rig.

Propriedades

Name
id
Type
string
Description
Identificador único da tarefa.
Name
type
Type
string
Description
Tipo da tarefa de Animação. O valor é animate.
Name
status
Type
string
Description
Status da tarefa. Valores possíveis: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progresso da tarefa (0-100).
Name
created_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) de quando a tarefa foi criada.
Um carimbo de data/hora representa o número de milissegundos decorridos desde 1º de janeiro de 1970 UTC, seguindo o padrão RFC 3339. Por exemplo, sexta-feira, 1º de setembro de 2023, 12:00:00 PM GMT é representado como 1693569600000. Isso se aplica a todos os carimbos de data/hora na Meshy API.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) de quando a tarefa começou a ser processada. 0 se não tiver iniciado.
Name
finished_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) de quando a tarefa foi concluída. 0 se não tiver sido concluída.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) de quando os assets resultantes da tarefa expiram.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas com falha. Consulte Erros para a referência completa do objeto task_error.
Name
consumed_credits
Type
integer
Description
O número de créditos consumidos por esta tarefa. Presente quando o status da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).
Name
result
Type
object
Description
Contém as URLs de animação de saída se a tarefa for SUCCEEDED.
- Name
  animation_glb_url
  Type
  string
  Description
  URL para download da animação no formato GLB.
- Name
  animation_fbx_url
  Type
  string
  Description
  URL para download da animação no formato FBX.
- Name
  processed_usdz_url
  Type
  string
  Description
  URL para download da animação processada no formato USDZ.
- Name
  processed_armature_fbx_url
  Type
  string
  Description
  URL para download do armature processado no formato FBX.
- Name
  processed_animation_fps_fbx_url
  Type
  string
  Description
  URL para download da animação com FPS alterado no formato FBX (por exemplo, se a operação change_fps foi usada).
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes na fila. Relevante apenas se o status for PENDING.

Example Animation Task Object

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.glb?...",
    "animation_fbx_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.fbx?...",
    "processed_usdz_url": "https://assets.meshy.ai/.../processed.usdz?...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/.../processed_armature.fbx?...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/.../processed_60fps.fbx?..."
  },
  "preceding_tasks": 0
}