API de Rigging

A API de Rigging permite adicionar programaticamente um esqueleto (armature) a modelos 3D humanoides, vinculando a malha a este para que fiquem prontos para animação. Para aplicar animações a uma personagem com rig, consulte a API de Animação.

Note que o rigging programático atualmente só funciona bem com assets humanoides padrão (bípedes) com membros e estrutura corporal claramente definidos.

POST/openapi/v1/rigging

Create a Rigging Task

Este endpoint permite criar uma nova tarefa de rigging para um determinado modelo 3D. Após a conclusão com sucesso, fornece uma personagem com rig em formatos padrão e, opcionalmente, animações básicas de andar/correr.

A tarefa é executada em segundo plano. Para saber quanto tempo normalmente demora, consulte Tempos de Processamento.

Atualmente, o auto-rigging não é adequado para os seguintes modelos:

Malhas sem textura
Assets não humanoides
Assets humanoides com estrutura de membros e corpo pouco clara

Ao usar input_task_id, modelos com mais de 300 000 faces não são suportados para rigging. Utilize a API de Remesh para reduzir o número de faces antes do rigging.

Ao usar model_url, o rosto da personagem deve apontar para o eixo +Z (a direção padrão de avanço no glTF). Modelos virados para outros eixos falharão na estimativa de pose.

Parâmetros

Apenas um dos parâmetros input_task_id ou model_url é obrigatório. Se ambos forem fornecidos, input_task_id tem prioridade.

Name
input_task_id
Type
string
Obrigatório
Description
A tarefa de entrada que precisa de rigging. Atualmente suportamos modelos humanoides texturizados.

Name
model_url
Type
string
Obrigatório
Description
Forneça um modelo 3D para a Meshy fazer o rigging através de um URL publicamente acessível ou de um Data URI. Atualmente suportamos ficheiros GLB humanoides texturizados (formato .glb).
Tamanho máximo do ficheiro: 400 MB para um URL http ou https, 100 MB para um URI data:.
Um ficheiro com mais de 100 MB e mais de 10 000 000 faces devolve 400. As faces são contadas como triângulos, e uma malha desenhada mais do que uma vez conta uma vez por cópia. Um GLB com mais de 100 MB não pode usar compressão Draco.

Name
height_meters
Type
number
predefinição 1.7
Description
A altura aproximada do modelo da personagem, em metros. Isto ajuda na precisão do escalamento e do rigging. Deve ser um número positivo.
Name
texture_image_url
Type
string
Description
A imagem de textura de cor base com UV desenrolado do modelo. URL publicamente acessível ou Data URI. Atualmente suportamos formatos .png.
Tamanho máximo do ficheiro: 20 MB.

Retorno

A propriedade result da resposta contém o id da tarefa da nova tarefa de rigging criada.

Modos de Falha

Name
400 - Bad Request
Description
O pedido foi inaceitável. Causas comuns:
- Parâmetro em falta: É necessário fornecer model_url ou input_task_id.
- Formato de modelo inválido: O model_url aponta para um ficheiro com uma extensão não suportada (apenas .glb é suportado).
- URL inacessível: Não foi possível transferir o model_url.
- Ficheiro de modelo demasiado grande: O ficheiro model_url excede 400 MB (URL http ou https) ou 100 MB (URI data:).
- Demasiadas faces: O ficheiro model_url tem mais de 100 MB e mais de 10 000 000 faces. Reduza o número de faces e volte a enviar o ficheiro.
- Ficheiro de modelo ilegível: O ficheiro model_url tem mais de 100 MB e o seu cabeçalho não pode ser lido, por exemplo, um GLB comprimido com Draco.
- Cabeçalho do modelo demasiado complexo: O ficheiro model_url tem mais de 100 MB e o seu cabeçalho tem demasiadas malhas, nós ou registos para verificar. Reduza o número de objetos no ficheiro e volte a enviá-lo.
- Imagem demasiado grande: A imagem texture_image_url excede 20 MB.
- Tarefa de entrada inválida: O input_task_id não corresponde a uma tarefa de API válida.
- Número de faces excedido: O modelo de entrada tem mais de 300 000 faces. Utilize a API de Remesh para reduzir o número de faces antes do rigging.
Name
401 - Unauthorized
Description
Falha na autenticação. Verifique a sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
422 - Unprocessable Entity
Description
A estimativa de pose falhou. O modelo fornecido pode não ser uma personagem humanoide válida.
Name
429 - Too Many Requests
Description
Excedeu o seu limite de taxa.

Request

POST

/openapi/v1/rigging

# Rig a model from a URL
curl https://api.meshy.ai/openapi/v1/rigging \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "YOUR_MODEL_URL_OR_DATA_URI",
    "height_meters": 1.8
  }'

Response

{
  "result": "018b314a-a1b5-716d-c222-2f1776f7f579"
}

GET/openapi/v1/rigging/:id

Obter uma Tarefa de Rigging

Este endpoint permite-lhe obter uma tarefa de rigging a partir de um id de tarefa válido. Consulte O Objeto Tarefa de Rigging para ver quais as propriedades incluídas.

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de rigging a obter.

Devolve

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

Request

GET

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

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

Response

{
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.fbx?Expires=...",
    "rigged_character_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.glb?Expires=...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.glb?Expires=...",
      "walking_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.fbx?Expires=...",
      "walking_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin_armature.glb?Expires=...",
      "running_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.glb?Expires=...",
      "running_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.fbx?Expires=...",
      "running_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin_armature.glb?Expires=..."
    }
  },
  "preceding_tasks": 0
}

DELETE/openapi/v1/rigging/:id

Eliminar uma Tarefa de Rigging

Este endpoint elimina permanentemente uma tarefa de rigging, 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 rigging a eliminar.

Estado da Tarefa

Uma tarefa que ainda está PENDING é eliminada e os créditos consumidos no momento da criação são reembolsados.

Uma tarefa que já está IN_PROGRESS não pode ser eliminada: o pedido é rejeitado com 409 Conflict e a tarefa continua em execução. Os créditos de uma tarefa que o worker já começou a processar não são reembolsáveis, pelo que eliminá-la a meio da execução custar-lhe-ia tanto os créditos como o resultado. Aguarde que atinja o estado SUCCEEDED, FAILED ou CANCELED e só depois a elimine.

Uma tarefa num estado terminal (SUCCEEDED, FAILED ou CANCELED) é eliminada sem reembolso.

Devolve

Devolve 200 OK em caso de sucesso, ou 409 Conflict quando a tarefa está IN_PROGRESS.

Request

DELETE

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

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

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/rigging

Listar Tarefas de Rigging

Devolve uma lista paginada das tarefas de rigging do autor da chamada, das mais recentes para as mais antigas. Paginação padrão através de page_num e page_size.

Note que as tarefas criadas através da API são geridas através da API — não aparecem em My Assets da aplicação web. Utilize este endpoint para encontrar uma tarefa cujo ID já não tenha.

Request

GET

/openapi/v1/rigging

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

GET/openapi/v1/rigging/:id/stream

Transmitir uma Tarefa de Rigging

Este endpoint transmite atualizações em tempo real para uma tarefa de Rigging utilizando Server-Sent Events (SSE).

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de Rigging a transmitir.

Retornos

Devolve um fluxo de Objetos de Tarefa de Rigging 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/rigging/018b314a-a1b5-716d-c222-2f1776f7f579/stream

curl -N https://api.meshy.ai/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579/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": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: { // Example of a SUCCEEDED task stream item, mirroring The Rigging Task Object structure
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/.../Character_output.fbx?...",
    "rigged_character_glb_url": "https://assets.meshy.ai/.../Character_output.glb?...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin.glb?...",
      "walking_fbx_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin.fbx?...",
      "walking_armature_glb_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin_armature.glb?...",
      "running_glb_url": "https://assets.meshy.ai/.../Animation_Running_withSkin.glb?...",
      "running_fbx_url": "https://assets.meshy.ai/.../Animation_Running_withSkin.fbx?...",
      "running_armature_glb_url": "https://assets.meshy.ai/.../Animation_Running_withSkin_armature.glb?..."
    }
  },
  "preceding_tasks": 0
}

O Objeto Rigging Task

O objeto Rigging Task representa a unidade de trabalho para fazer o rigging de uma personagem.

Propriedades

Name
id
Type
string
Description
Identificador único da tarefa.
Name
type
Type
string
Description
Tipo da tarefa de Rigging. O valor é rig.
Name
status
Type
string
Description
Estado da tarefa. Valores possíveis: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progresso da tarefa (0-100). 0 se não tiver começado, 100 se tiver sido bem-sucedida.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a epoch) 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 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 epoch) de quando 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 epoch) de quando a tarefa terminou. 0 se não tiver terminado.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora (milissegundos desde a epoch) de quando os assets resultantes da tarefa expiram e podem ser eliminados.
Name
task_error
Type
object
Description
Detalhes de 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 dos assets de saída se a tarefa tiver sido SUCCEEDED, null caso contrário.
- Name
  rigged_character_fbx_url
  Type
  string
  Description
  URL para download da personagem com rigging em formato FBX.
- Name
  rigged_character_glb_url
  Type
  string
  Description
  URL para download da personagem com rigging em formato GLB.
- Name
  basic_animations
  Type
  object (optional)
  Description
  Contém os URLs das animações predefinidas. (por exemplo, se generate_basic_animations tiver sido implicitamente verdadeiro ou ativado por predefinição).
  Name
  walking_glb_url
  Type
  string
  Description
  URL para download da animação de caminhar em formato GLB (com skin).
  Name
  walking_fbx_url
  Type
  string
  Description
  URL para download da animação de caminhar em formato FBX (com skin).
  Name
  walking_armature_glb_url
  Type
  string
  Description
  URL para download da armature da animação de caminhar em formato GLB.
  Name
  running_glb_url
  Type
  string
  Description
  URL para download da animação de correr em formato GLB (com skin).
  Name
  running_fbx_url
  Type
  string
  Description
  URL para download da animação de correr em formato FBX (com skin).
  Name
  running_armature_glb_url
  Type
  string
  Description
  URL para download da armature da animação de correr em formato GLB.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes na fila. Relevante apenas se o estado for PENDING.

Example Rigging Task Object

{
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.fbx?Expires=...",
    "rigged_character_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.glb?Expires=...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.glb?Expires=...",
      "walking_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.fbx?Expires=...",
      "walking_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin_armature.glb?Expires=...",
      "running_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.glb?Expires=...",
      "running_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.fbx?Expires=...",
      "running_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin_armature.glb?Expires=..."
    }
  },
  "preceding_tasks": 0
}