API de Animação

O id de uma tarefa de rigging concluída com sucesso (de POST /openapi/v1/rigging). A personagem desta tarefa será animada.

O identificador da ação de animação predefinida a aplicar. Consulte a Referência da Biblioteca de Animações para uma lista completa das animações disponíveis. Forneça exatamente um de action_id, action_ids ou motion_task_id.

Várias ações de animação predefinidas a aplicar em simultâneo, devolvidas como um único ficheiro contendo um clip de animação por ação — útil para controlar uma personagem a partir de uma máquina de estados num motor de jogo. Forneça entre 1 e 10 valores de action_id da Referência da Biblioteca de Animações; os ids devem ser únicos. Custa 3 créditos por ação. Forneça exatamente um de action_id, action_ids ou motion_task_id.

Passar um action_ids com um único elemento é equivalente a passar esse valor como action_id.

O id de uma tarefa de Text to Motion concluída com sucesso a aplicar em vez de uma ação predefinida. O clip gerado é reorientado (retargeted) para a personagem com rig e o clip é capturado num snapshot no momento da criação, pelo que esta tarefa não é afetada caso a tarefa de origem expire ou seja eliminada posteriormente. Os assets da tarefa de origem são mantidos durante 3 dias — aplique o clip antes que expire. Requer um rig bípede. Forneça exatamente um de action_id, action_ids ou motion_task_id.

Pós-processamento opcional para o resultado da animação. Omita para receber os ficheiros de animação padrão.

O pedido não foi aceite. Causas comuns:

• Parâmetro em falta: rig_task_id está em falta, ou nenhum de action_id, action_ids e motion_task_id foi fornecido.
• Parâmetros em conflito: foi fornecido mais do que um de action_id, action_ids e motion_task_id — são mutuamente exclusivos.
• Tarefa de rig inválida: O rig_task_id é inválido ou refere-se a uma tarefa falhada/inexistente.
• ID de ação inválido: Um action_id — ou uma entrada de action_ids — não corresponde a uma animação válida.
• Demasiadas ações: action_ids contém mais de 10 ids.
• Ações duplicadas: action_ids contém o mesmo id mais do que uma vez.
• Tarefa de movimento não pronta: a tarefa motion_task_id ainda não terminou com SUCCEEDED.
• Rig não suportado: motion_task_id requer um rig bípede; rigs quadrúpedes são rejeitados.

A autenticação falhou. Verifique a sua chave de API.

Créditos insuficientes para realizar esta tarefa.

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 clip de movimento expirou (os assets da tarefa de origem são mantidos durante 3 dias).

Excedeu o seu limite de taxa.

Identificador único da tarefa de animação a obter.

O ID da tarefa de animação a eliminar.

Identificador único da tarefa de Animação a transmitir.

Identificador único da tarefa.

Tipo da tarefa de Animação. O valor é animate.

Estado da tarefa. Valores possíveis: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progresso da tarefa (0-100).

Carimbo de data/hora (milissegundos desde a epoch) de quando a tarefa foi criada.

Carimbo de data/hora (milissegundos desde a epoch) de quando a tarefa começou a ser processada. 0 se ainda não tiver começado.

Carimbo de data/hora (milissegundos desde a epoch) de quando a tarefa terminou. 0 se ainda não tiver terminado.

Carimbo de data/hora (milissegundos desde a epoch) de quando os assets resultantes da tarefa expiram.

Detalhes do erro para tarefas falhadas. Consulte Erros para a referência completa do objeto task_error.

O número de créditos consumidos por esta tarefa. Presente quando o estado da tarefa é PENDING, IN_PROGRESS, ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

Contém os URLs de animação de saída se a tarefa tiver SUCCEEDED.

A contagem de tarefas precedentes na fila. Apenas relevante se o estado for PENDING.

Correspondência de subcadeia sem distinção entre maiúsculas e minúsculas em name ou key. A correspondência é literal, pelo que % e _ são carateres comuns e não caracteres universais (wildcards).

Correspondência exata em category.

Valores disponíveis:

• WalkAndRun
• BodyMovements
• DailyActions
• Fighting
• Dancing

Correspondência exata em sub_category. Aceite isoladamente — os nomes de sub-categoria não são únicos entre categorias (Transitioning aparece tanto em Fighting como em DailyActions), pelo que, sem uma category, o filtro corresponde a essa sub-categoria onde quer que apareça.

Lista separada por vírgulas de valores action_id a devolver, para resolver ids específicos em vez de navegar. Aceita no máximo 200 ids. Os ids que nenhuma animação possui estão simplesmente ausentes da resposta, pelo que também pode usar isto para verificar se os ids que tem armazenados ainda estão disponíveis.

O valor a passar como action_id ao criar uma tarefa de animação. Único e estável, mas não contíguo — as animações descontinuadas deixam lacunas na numeração, pelo que nunca deve assumir que um intervalo de ids é válido.

Rótulo legível por humanos, para apresentação. Não é único: algumas animações partilham um nome com uma variante diferente, pelo que deve usar action_id ou key como identidade.

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

Agrupamento de nível superior, por exemplo Fighting.

Agrupamento dentro da categoria, por exemplo AttackingwithWeapon.

URL de um GIF animado com a pré-visualização da ação, adequado para ser apresentado diretamente no seu próprio seletor.