API de Animação

O ID da tarefa de Rigging cuja personagem deve ser animada, obtido através de POST /openapi/v1/rigging. A tarefa tem de ter o estado SUCCEEDED.

Obrigatório, exceto se enviar action_ids ou motion_task_id. O ID da animação predefinida a aplicar. Para a lista completa de animações, consulte a referência da Biblioteca de animações ou Listar animações.

Obrigatório, exceto se enviar action_id ou motion_task_id. Os IDs de 1 a 10 ações predefinidas a aplicar de uma só vez, sem repetições. Mais de 10 IDs, ou um ID repetido, devolve 400. Para os IDs, consulte a referência da Biblioteca de animações.

A Meshy devolve um ficheiro com um clip de animação por ação, o que é adequado para uma state machine num 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, exceto se enviar action_id ou action_ids. O ID de uma tarefa Text to Motion cujo clip deve ser aplicado em vez de uma ação predefinida. A tarefa tem de ter o estado SUCCEEDED, e o rig tem de ser bípede.

A Meshy faz o retarget do clip para a personagem com rig. Copia o clip quando esta tarefa é criada, por isso esta tarefa não é afetada caso a tarefa de Text to Motion expire mais tarde ou a elimine. A Meshy mantém os ficheiros da tarefa de Text to Motion durante 3 dias, por isso aplique o clip antes de esse prazo terminar.

Pós-processamento para o resultado da animação. Omita este parâmetro para obter os ficheiros de animação padrão.

Com motion_task_id, o retarget pode produzir uma animação apenas em GLB. Se enviar post_process e não estiver disponível nenhum ficheiro FBX, a tarefa falha com um task_error, e a Meshy reembolsa os seus créditos. Sem post_process, a tarefa é concluída com sucesso, e animation_fbx_url fica vazio.

O pedido não pode ser executado. A mensagem de erro indica qual o problema encontrado. Por exemplo:

• Parâmetro em falta: rig_task_id está em falta, ou nenhum dos parâmetros action_id, action_ids e motion_task_id foi enviado.
• Parâmetros em conflito: O pedido tem mais do que 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 concluída com sucesso.
• ID de ação inválido: Um action_id, ou uma entrada em action_ids, não é uma animação válida.
• Demasiadas ações: action_ids tem mais de 10 IDs.
• Ações duplicadas: action_ids tem o mesmo ID mais do que uma vez.
• Tarefa de movimento não pronta: A tarefa motion_task_id ainda não atingiu o estado SUCCEEDED.
• Rig não suportado: motion_task_id requer um rig bípede, e a Meshy rejeita um rig quadrúpede.

Corrija o pedido e envie-o novamente. Consulte Erros.

A chave de API está em falta 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éditos. Verifique o seu saldo de créditos e tente novamente.
• Plano gratuito: Criar uma tarefa requer um plano pago. Atualize o seu plano nas definições de subscrição e tente novamente.

A tarefa rig_task_id é um modelo em baixo-relevo, que este endpoint não consegue animar. A mensagem é This model type does not support this operation. Faça rig de um modelo diferente.

A Meshy não consegue encontrar uma tarefa ou ficheiro de que o pedido necessita. Aplica-se uma das seguintes situações:

• A Meshy não consegue encontrar a tarefa rig_task_id entre as suas tarefas. Verifique o ID.
• A Meshy eliminou os ficheiros da tarefa rig_task_id após o respetivo expires_at. Faça rig da personagem novamente.
• A Meshy não consegue encontrar a tarefa motion_task_id. Verifique o ID.
• O clip de movimento expirou, porque a Meshy mantém os ficheiros de uma tarefa de Text to Motion durante 3 dias. Crie outra tarefa de Text to Motion.

Excedeu o seu limite de taxa. Aguarde e tente novamente. Consulte Limites de taxa.

O ID da tarefa proveniente da resposta de criação.

O ID da tarefa a eliminar.

O ID da tarefa proveniente da resposta de criação.

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

O tipo de tarefa, sempre animate.

O estado da tarefa, um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ou CANCELED.

Quanto da tarefa está concluído, em percentagem. É 0 até a tarefa começar e 100 quando é bem-sucedida.

Momento em que a tarefa foi criada, em milissegundos Unix.

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

Momento em que a tarefa terminou, em milissegundos Unix. É 0 até a tarefa terminar.

Momento em que os ficheiros de resultado da tarefa expiram, em milissegundos Unix.

Os detalhes do erro quando a tarefa falha. É null a menos que o estado seja FAILED. Consulte Erros.

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

URLs de transferência para os ficheiros de animação, quando a tarefa tem o estado SUCCEEDED.

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

Texto a pesquisar. O Meshy devolve as animações cujo name ou key contém este texto, ignorando maiúsculas/minúsculas. O Meshy compara o texto literalmente, pelo que % e _ não são caracteres universais.

A categoria a listar, como correspondência exata. Uma categoria desconhecida devolve uma lista vazia.

Valores disponíveis:

• WalkAndRun
• BodyMovements
• DailyActions
• Fighting
• Dancing

A subcategoria a listar, como correspondência exata. Pode enviá-la sem category. Os nomes de subcategoria não são únicos entre categorias. Por exemplo, Transitioning está presente tanto em Fighting como em DailyActions. Assim, sem category, o filtro corresponde à subcategoria em todas as categorias.

As animações a devolver, até 200 valores de action_id separados por vírgulas. Utilize-o para procurar IDs específicos em vez de navegar. Mais de 200 IDs devolve 400.

A resposta omite um ID que nenhuma animação possui. Pode também usar este filtro para verificar se os IDs que armazenou ainda estão disponíveis.

O valor a enviar como action_id quando cria uma tarefa de Animação. É único e estável, mas não contíguo. As animações retiradas deixam lacunas na numeração, por isso não assuma que todos os IDs num intervalo são válidos.

O nome de exibição da animação. Não é único, porque algumas animações partilham 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 o seu próprio armazenamento.

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

O grupo dentro da categoria, por exemplo AttackingwithWeapon.

URL de uma pré-visualização em GIF animado da ação. Pode mostrá-lo diretamente no seu próprio seletor.