API de Animação

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

POST/openapi/v1/animations

Criar uma tarefa de Animação

Este endpoint permite-lhe criar uma nova tarefa para aplicar uma ação de animação específica a uma personagem à qual foi previamente aplicado rigging. 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). A personagem desta tarefa será animada.
Name
action_id
Type
integer
Obrigatório
Description
O identificador da ação de animação a aplicar. Consulte a Referência da Biblioteca de animações para obter uma lista completa das animações disponíveis.
Name
post_process
Type
object
Description
Pós-processamento opcional para a saída da animação. Omita-o para receber os ficheiros de animação padrão.

Aplica-se apenas quando post_process is set

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

Devoluções

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

Modos de falha

Name
400 - Bad Request
Description
O pedido não era aceitável. Causas comuns:
- Parâmetro em falta: rig_task_id ou action_id está em falta.
- Tarefa de rigging inválida: O rig_task_id é inválido ou refere-se a uma tarefa falhada/inexistente.
- ID de ação inválido: O action_id não corresponde a uma animação válida.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique a sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
404 - Not Found
Description
A tarefa de rigging especificada por rig_task_id não foi encontrada.
Name
429 - Too Many Requests
Description
Excedeu o 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
  }'

# 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

Obter uma Tarefa de Animação

Este endpoint permite-lhe obter uma tarefa de animação dado um id de tarefa válido. Consulte O Objeto de Tarefa de Animação para ver que propriedades estão incluídas.

Parâmetros

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

Devolve

A resposta contém o objeto Tarefa de Animação. Consulte a secção O Objeto de Tarefa de Animação para obter 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

Eliminar uma Tarefa de Animação

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

Parâmetros de Caminho

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

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/: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 transmitir.

Devolve

Devolve um fluxo de Objetos da tarefa de Animação 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 Tarefa de Animação representa a unidade de trabalho para aplicar uma Animação a uma 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
Estado da tarefa. Valores possíveis: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress da tarefa (0-100).
Name
created_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) em que a tarefa foi criada.
Um carimbo de data/hora representa o número de milissegundos decorridos desde 1 de janeiro de 1970 UTC, seguindo a norma RFC 3339. Por exemplo, sexta-feira, 1 de setembro de 2023 12:00:00 GMT é representado como 1693569600000. Isto aplica-se a todos os carimbos de data/hora na Meshy API.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) em que a tarefa começou a ser processada. 0 se não tiver começado.
Name
finished_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) em que a tarefa terminou. 0 se não tiver terminado.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a época) em que os ativos de resultado da tarefa expiram.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas falhadas. 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 estado da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).
Name
result
Type
object
Description
Contém os URLs da animação de saída se a tarefa tiver SUCCEEDED.
- Name
  animation_glb_url
  Type
  string
  Description
  URL descarregável para a animação no formato GLB.
- Name
  animation_fbx_url
  Type
  string
  Description
  URL descarregável para a animação no formato FBX.
- Name
  processed_usdz_url
  Type
  string
  Description
  URL descarregável para a animação processada no formato USDZ.
- Name
  processed_armature_fbx_url
  Type
  string
  Description
  URL descarregável para a armature processada no formato FBX.
- Name
  processed_animation_fps_fbx_url
  Type
  string
  Description
  URL descarregável para a animação com FPS alterado no formato FBX (por exemplo, se a operação change_fps tiver sido utilizada).
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas anteriores na fila. Significativo apenas se o estado 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
}