API de Animação

O ID da tarefa de Rigging cujo personagem será animado, obtido em POST /openapi/v1/rigging. A tarefa deve ter o status SUCCEEDED.

Obrigatório, a menos que você envie action_ids ou motion_task_id. O ID da animação predefinida a ser aplicada. Para a lista completa de animações, consulte a referência da Biblioteca de animações ou Listar animações.

Obrigatório, a menos que você envie action_id ou motion_task_id. Os IDs de 1 a 10 animações predefinidas a serem aplicadas de uma vez, sem repetições. Mais de 10 IDs, ou um ID repetido, retorna 400. Para os IDs, consulte a referência da Biblioteca de animações.

A Meshy retorna um arquivo com um clipe de animação por ação, o que se adequa a uma máquina de estados em um motor de jogo. A Meshy cobra por cada ação na lista. Consulte Preços.

Uma lista com um único ID funciona da mesma forma que enviar esse ID como action_id.

Obrigatório, a menos que você envie action_id ou action_ids. O ID de uma tarefa Text to Motion cujo clipe será aplicado em vez de uma ação predefinida. A tarefa deve ter o status SUCCEEDED, e o rig deve ser bípede.

A Meshy retarget (reaplica) o clipe sobre o personagem rigado. Ela copia o clipe ao criar esta tarefa, então esta tarefa não é afetada se a tarefa de Text to Motion expirar depois ou se você excluí-la. A Meshy mantém os arquivos da tarefa de Text to Motion por 3 dias, então aplique o clipe antes desse prazo.

Pós-processamento para a saída da animação. Omita para obter os arquivos de animação padrão.

Com motion_task_id, o retarget pode produzir uma animação apenas em GLB. Se você enviar post_process e nenhum arquivo FBX estiver disponível, a tarefa falha com um task_error, e a Meshy reembolsa seus créditos. Sem post_process, a tarefa é bem-sucedida, e animation_fbx_url fica vazio.

A requisição não pode ser executada. A mensagem de erro indica qual problema foi encontrado. Por exemplo:

• Parâmetro ausente: rig_task_id está ausente, ou nenhum dos parâmetros action_id, action_ids e motion_task_id foi enviado.
• Parâmetros conflitantes: A requisição tem mais de um dos parâmetros action_id, action_ids e motion_task_id. Envie apenas um.
• Tarefa de rig inválida: rig_task_id não é um ID de tarefa válido, não é uma tarefa de Rigging, ou aponta para uma tarefa que não foi bem-sucedida.
• ID de ação inválido: Um action_id, ou uma entrada em action_ids, não é uma animação válida.
• Ações em excesso: action_ids tem mais de 10 IDs.
• Ações duplicadas: action_ids tem o mesmo ID mais de uma vez.
• Tarefa de movimento não pronta: A tarefa de motion_task_id ainda não atingiu o status SUCCEEDED.
• Rig não suportado: motion_task_id requer um rig bípede, e a Meshy rejeita um rig quadrúpede.

Corrija a requisição e envie-a novamente. Consulte Erros.

A chave de API está ausente ou é inválida. Verifique o cabeçalho Authorization.

Por exemplo:

• Créditos insuficientes: A conta não tem créditos suficientes para esta tarefa, ou a conta atingiu um limite de crédito. Verifique seu saldo de créditos e tente novamente.
• Plano gratuito: Criar uma tarefa requer um plano pago. Atualize seu plano nas configurações de assinatura e tente novamente.

A tarefa referenciada por rig_task_id é um modelo de baixo-relevo, que este endpoint não pode animar. A mensagem é This model type does not support this operation. Rig um modelo diferente.

A Meshy não consegue encontrar uma tarefa ou arquivo que a requisição precisa. Um destes se aplica:

• A Meshy não consegue encontrar a tarefa rig_task_id entre suas tarefas. Verifique o ID.
• A Meshy excluiu os arquivos da tarefa rig_task_id após seu expires_at. Rig o personagem novamente.
• A Meshy não consegue encontrar a tarefa motion_task_id. Verifique o ID.
• O clipe de movimento expirou, pois a Meshy mantém os arquivos de uma tarefa de Text to Motion por 3 dias. Crie outra tarefa de Text to Motion.

Você excedeu seu limite de taxa. Aguarde e tente novamente. Consulte Limites de taxa.

O ID da tarefa obtido na resposta de criação.

O ID da tarefa a ser excluída.

O ID da tarefa retornado na resposta de criação.

O ID da tarefa. Trate-o como uma string opaca e não dependa do seu formato.

O tipo da tarefa, sempre animate.

O status da tarefa, um dos seguintes: PENDING, IN_PROGRESS, SUCCEEDED, FAILED ou CANCELED.

Quanto da tarefa foi concluído, em porcentagem. É 0 até a tarefa começar e 100 quando ela é bem-sucedida.

Horário em que a tarefa foi criada, em milissegundos Unix.

Horário em que a tarefa começou, em milissegundos Unix. É 0 até a tarefa começar.

Horário em que a tarefa terminou, em milissegundos Unix. É 0 até a tarefa terminar.

Horário em que os arquivos de resultado da tarefa expiram, em milissegundos Unix.

Os detalhes do erro quando a tarefa falha. Veja Erros.

O número de créditos que a tarefa usou. Presente quando o status é PENDING, IN_PROGRESS ou SUCCEEDED. É 0 para uma tarefa FAILED, porque a Meshy reembolsa os créditos quando uma tarefa falha.

URLs de download para os arquivos de animação, quando a tarefa tem o status SUCCEEDED.

O número de tarefas à frente desta na fila. O valor só é significativo enquanto a tarefa está PENDING.

Texto a ser pesquisado. Meshy retorna as animações cujo name ou key contém esse texto, ignorando maiúsculas/minúsculas. Meshy compara o texto literalmente, então % e _ não são caracteres curinga.

A categoria a ser listada, como correspondência exata. Uma categoria desconhecida retorna uma lista vazia.

Valores disponíveis:

• WalkAndRun
• BodyMovements
• DailyActions
• Fighting
• Dancing

A subcategoria a ser listada, como correspondência exata. Você pode enviá-la sem category. Os nomes de subcategoria não são únicos entre categorias. Por exemplo, Transitioning existe tanto em Fighting quanto em DailyActions. Então, sem category, o filtro corresponde à subcategoria em todas as categorias.

As animações a serem retornadas, como até 200 valores action_id separados por vírgula. Use isso para buscar IDs específicos em vez de navegar pela lista. Mais de 200 IDs retorna 400.

A resposta omite um ID que não corresponde a nenhuma animação. Então você também pode usar esse filtro para verificar se os IDs que você armazenou ainda estão disponíveis.

O valor a ser enviado como action_id ao criar uma tarefa de Animação. É único e estável, mas não contíguo. Animações descontinuadas deixam lacunas na numeração, então não presuma que todo ID em um intervalo seja válido.

O nome de exibição da animação. Não é único, pois algumas animações compartilham o nome com outra variante. Para identificar uma animação, use action_id ou key.

Um slug único e estável para a animação. Use-o quando precisar de um ID não numérico para indexar seu próprio armazenamento.

O grupo de nível superior, por exemplo Fighting.

O grupo dentro da categoria, por exemplo AttackingwithWeapon.

URL de um GIF animado de pré-visualização da ação. Você pode exibi-lo diretamente em seu próprio seletor.