API de Figure do Creative Lab

A fotografia a transformar numa figura chibi, como um URL público ou um data URI (data:image/jpeg;base64,<os seus dados de imagem codificados em base64>).

A imagem deve ser um ficheiro JPG, JPEG, PNG ou WebP com, no máximo, 20 MB.

Um nome para a tarefa, até 100 caracteres. É devolvido no campo name da tarefa. Um nome mais longo devolve 400.

Se deve remover o fundo da imagem de prototype. true devolve um PNG RGBA transparente, para que possa colocar o sujeito sobre qualquer fundo. A construção também parte da imagem sem o seu fundo. Se a Meshy não conseguir remover o fundo, devolve a imagem com o seu fundo, e a tarefa ainda assim é bem-sucedida.

O pedido não pode ser executado. Por exemplo:

• image_url está em falta.
• A imagem não é um ficheiro JPG, JPEG, PNG ou WebP.
• A imagem é demasiado pequena, excede 20 MB, ou excede o número máximo de píxeis.
• A Meshy não consegue transferir a imagem, por exemplo porque o URL devolve 404 ou expira o tempo limite.
• O data URI não é um base64 válido.
• A imagem foi assinalada como NSFW.

A mensagem de erro indica qual o problema encontrado. Corrija o pedido e envie-o novamente.

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

Aplica-se uma das seguintes situações:

• A conta não tem créditos suficientes.
• A chave de API, o espaço de trabalho ou o membro atingiu o seu limite de créditos.
• A conta está no plano gratuito.

Verifique os seus créditos e plano, e tente novamente.

A sua equipa tem a Filtragem de IP ativada, e a Meshy assinalou a imagem por propriedade intelectual de terceiros. Envie uma imagem que tenha o direito de utilizar.

Um destes limites foi atingido:

• Enviou mais pedidos do que o permitido pelo seu limite de taxa. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Demasiadas das suas tarefas estão em fila de espera ou em execução. Aguarde que algumas terminem e tente novamente.
• Num plano ilimitado sem créditos restantes, atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde que uma tarefa termine, ou adicione créditos.

A Meshy encontrou um erro de servidor, por exemplo porque não conseguiu executar a verificação de propriedade intelectual na imagem. A Meshy não cria a tarefa, e reembolsa quaisquer créditos que tenha cobrado. Tente o pedido novamente.

O ID da tarefa de protótipo a criar. Tem de ser uma tarefa criada pela sua conta com POST /openapi/creative-lab/figure/v1/prototype, com o estado SUCCEEDED.

Um ID que não corresponda a uma das suas tarefas de protótipo de figura da API devolve 404, incluindo um protótipo criado na aplicação web.

Um nome para a tarefa, até 100 caracteres. É devolvido no campo name da tarefa. Um nome mais longo devolve 400.

O pedido não pode ser executado. Por exemplo:

• input_task_id está em falta ou não é um ID de tarefa válido.
• O estado da tarefa de protótipo não é SUCCEEDED. Se ainda estiver em execução, aguarde e tente novamente. Se tiver falhado ou sido cancelada, crie uma nova tarefa de protótipo.
• A tarefa de protótipo foi bem-sucedida, mas não tem imagem. Crie uma nova tarefa de protótipo.

A mensagem de erro indica qual o problema encontrado.

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

Aplica-se uma das seguintes situações:

• A conta não tem créditos suficientes.
• A chave de API, o espaço de trabalho ou o membro atingiu o respetivo limite de créditos.
• A conta está no plano gratuito.

Verifique os seus créditos e o seu plano e tente novamente.

input_task_id não corresponde a nenhuma tarefa de protótipo de figura criada pela sua conta através da API. Um protótipo criado na aplicação web também devolve 404. Envie o ID result de uma resposta de criação de protótipo.

Foi atingido um dos seguintes limites:

• Enviou mais pedidos do que o seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Existem demasiadas tarefas suas em fila de espera ou em execução. Aguarde que algumas terminem e tente novamente.
• Num plano ilimitado sem créditos restantes, atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde que uma tarefa termine ou adicione créditos.

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

id não é um ID de tarefa válido. Envie o ID result proveniente da resposta de criação.

A sua equipa tem a Filtragem de IP ativada, e a Meshy sinalizou a imagem da tarefa por propriedade intelectual de terceiros. As equipas no plano Enterprise não recebem este erro. Crie uma tarefa de protótipo a partir de uma imagem que tenha o direito de utilizar.

Nenhuma tarefa Figure com este ID pertence à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build para corresponder à tarefa.

A Meshy não conseguiu executar a verificação de propriedade intelectual. Repita o pedido.

O ID da tarefa a cancelar.

Aplica-se um dos seguintes casos:

• id não é um ID de tarefa válido. Envie o ID result da resposta de criação.
• A tarefa já tem um estado final (SUCCEEDED, FAILED ou CANCELED), pelo que não pode ser cancelada.

Não existe nenhuma tarefa de Figure com este ID associada à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build para corresponder à tarefa.

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

O estágio a listar, prototype ou build.

A página a devolver, de 1 a 255. 0 devolve a primeira página. Um valor fora do intervalo 0 a 255 devolve 400.

Número de tarefas por página, até 100. Um valor entre 101 e 255 devolve 100 tarefas, e 0 utiliza o valor predefinido. Um valor fora do intervalo 0 a 255 devolve 400.

A ordem de ordenação.

Valores disponíveis:

• -created_at: mais recente primeiro
• +created_at: mais antigo primeiro

O ID da tarefa. Não dependa do seu formato.

O tipo de tarefa, sempre creative-lab-figure-prototype.

O name que enviou ao criar a tarefa, ou "" se não tiver enviado nenhum.

O estado da tarefa.

Valores disponíveis:

• PENDING: à espera na fila
• IN_PROGRESS: a gerar o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

Percentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando é bem-sucedida.

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

Hora em que um worker iniciou a tarefa, em milissegundos Unix. null até isso acontecer.

Hora em que a tarefa atingiu um estado final, em milissegundos Unix. null até isso acontecer.

Hora em que o resultado da tarefa expira, em milissegundos Unix. É 3 dias após finished_at, ou 3 dias após created_at até a tarefa terminar. Para contas Enterprise, que mantêm os resultados da API indefinidamente, é cerca de 100 anos depois. Consulte Retenção de recursos.

A posição da tarefa na fila enquanto está PENDING. 1 significa que é a próxima a começar. 0 depois de a tarefa sair da fila, e sempre 0 em resultados de listas.

O motivo pelo qual a tarefa falhou. null a menos que status seja FAILED. Consulte Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Um pedido que retorna um erro não é cobrado. Uma tarefa falhada é 0, porque a Meshy reembolsa-a. Cancelar só reembolsa uma tarefa enquanto esta está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream omite o campo, e um pedido de lista retorna 500. Nesse caso, tente novamente o pedido.

URLs de transferência para a imagem conceptual. O array tem um URL depois de a tarefa ser bem-sucedida, e está vazio até lá.

O ID da tarefa. Não confie no seu formato.

O tipo da tarefa, sempre creative-lab-figure-build.

O name que enviou ao criar a tarefa, ou "" se não tiver enviado nenhum.

O estado da tarefa.

Valores disponíveis:

• PENDING: a aguardar na fila
• IN_PROGRESS: a gerar o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

Percentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando é bem-sucedida.

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

Hora em que um worker iniciou a tarefa, em milissegundos Unix. null até isso acontecer.

Hora em que a tarefa atingiu um estado final, em milissegundos Unix. null até isso acontecer.

Hora em que o resultado da tarefa expira, em milissegundos Unix. É 3 dias após finished_at, ou 3 dias após created_at até a tarefa terminar. Para contas Enterprise, que mantêm os resultados da API indefinidamente, é cerca de 100 anos depois. Consulte Retenção de recursos.

A posição da tarefa na fila enquanto está PENDING. 1 significa que começa a seguir. 0 depois de a tarefa sair da fila, e sempre 0 em resultados de listagem.

Motivo pelo qual a tarefa falhou. null a menos que status seja FAILED. Consulte Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Um pedido que devolve um erro não é cobrado. Uma tarefa falhada é 0, porque a Meshy reembolsa-a. Cancelar só reembolsa uma tarefa enquanto esta está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de obtenção ou de fluxo omite o campo, e um pedido de listagem devolve 500. Nesse caso, tente novamente o pedido.

Sempre "" para uma tarefa de construção de figura.

Sempre "" para uma tarefa de construção de figura, tal como prompt.

Sempre "" para uma tarefa de construção de figura, tal como prompt.

Sempre "" para uma tarefa de construção de figura, tal como prompt.

URLs de transferência para o modelo 3D, como um GLB texturizado e como um ficheiro OBJ com o respetivo ficheiro MTL.

URL de transferência para uma imagem de pré-visualização do modelo.

Os mapas de textura, como um array com um objeto que contém o mapa de cor base.

Se a Meshy removeu reflexos e sombras da textura de cor base.