API de Figure do Creative Lab

A foto a ser transformada em uma figura chibi, como uma URL pública ou um Data URI (data:image/jpeg;base64,<seus dados de imagem codificados em base64>).

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

Um nome para a tarefa, com até 100 caracteres. Ele retorna no campo name da tarefa. Um nome mais longo retorna 400.

Se o plano de fundo deve ser removido da imagem de prototype. true retorna um PNG RGBA transparente, para que você possa colocar o assunto em qualquer plano de fundo. O build também começa a partir da imagem sem o plano de fundo. Se o Meshy não conseguir remover o plano de fundo, ele retorna a imagem com seu plano de fundo, e a tarefa ainda é bem-sucedida.

A solicitação não pode ser executada. Por exemplo:

• image_url está ausente.
• A imagem não é um arquivo JPG, JPEG, PNG ou WebP.
• A imagem é muito pequena, excede 20 MB, ou excede a contagem máxima de pixels.
• O Meshy não consegue baixar a imagem, por exemplo porque a URL retorna 404 ou expira.
• O Data URI não é um base64 válido.
• A imagem foi sinalizada como NSFW.

A mensagem de erro informa qual problema foi encontrado. Corrija a solicitação e a envie novamente.

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

Um destes se aplica:

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

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

Sua equipe tem a Filtragem de IP ativada, e o Meshy sinalizou a imagem por propriedade intelectual de terceiros. Envie uma imagem que você tenha o direito de usar.

Um destes limites foi atingido:

• Você enviou mais solicitações do que seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Muitas de suas tarefas estão na fila ou em execução. Aguarde algumas terminarem e tente novamente.
• Em um plano ilimitado sem créditos restantes, você atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde uma tarefa terminar, ou adicione créditos.

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

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

Um ID que não seja de uma das suas tarefas de protótipo de Figure da API retorna 404, incluindo um protótipo feito no aplicativo web.

Um nome para a tarefa, com até 100 caracteres. Ele é retornado no campo name da tarefa. Um nome mais longo retorna 400.

A solicitação não pode ser executada. Por exemplo:

• input_task_id está ausente ou não é um ID de tarefa válido.
• O status 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 problema foi encontrado.

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

Um destes casos se aplica:

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

Verifique seus créditos e seu plano e, em seguida, tente novamente.

input_task_id não corresponde a nenhuma tarefa de protótipo de Figure criada pela sua conta com a API. Um protótipo feito no aplicativo web também retorna 404. Envie o ID result de uma resposta de criação de protótipo.

Um destes limites foi atingido:

• Você enviou mais solicitações do que seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Veja Limites de taxa.
• Há tarefas suas demais na fila ou em execução. Aguarde algumas terminarem e tente novamente.
• Em um plano ilimitado sem créditos restantes, você atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde uma tarefa terminar ou adicione créditos.

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

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

Sua equipe está com o IP Filtering ativado, e a Meshy sinalizou a imagem da tarefa por propriedade intelectual de terceiros. Equipes no plano Enterprise não recebem esse erro. Crie uma tarefa de prototype a partir de uma imagem sobre a qual você tenha os direitos de uso.

Nenhuma tarefa de Figure com este ID pertence à sua conta, ou o estágio da tarefa não corresponde ao caminho. Verifique o ID e use /prototype ou /build de acordo com a tarefa.

A Meshy não conseguiu executar a verificação de propriedade intelectual. Tente novamente a solicitação.

O ID da tarefa a ser cancelada.

Um destes se aplica:

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

Nenhuma tarefa de Figure com este ID pertence à sua conta, ou o estágio da tarefa não corresponde ao caminho. Verifique o ID e use /prototype ou /build para corresponder à tarefa.

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

O estágio a ser listado, prototype ou build.

A página a ser retornada, de 1 a 255. 0 retorna a primeira página. Um valor fora do intervalo de 0 a 255 retorna 400.

Número de tarefas por página, até 100. Um valor de 101 a 255 retorna 100 tarefas, e 0 usa o padrão. Um valor fora do intervalo de 0 a 255 retorna 400.

A ordem de classificação.

Valores disponíveis:

• -created_at: mais recentes primeiro
• +created_at: mais antigos primeiro

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

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

O name que você enviou ao criar a tarefa, ou "" se você não enviou um.

O status da tarefa.

Valores disponíveis:

• PENDING: aguardando na fila
• IN_PROGRESS: gerando o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

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

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

Momento em que um worker iniciou a tarefa, em milissegundos Unix. null até então.

Momento em que a tarefa atingiu um status final, em milissegundos Unix. null até então.

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

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

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

Número de créditos cobrados pela tarefa, após qualquer reembolso. Uma requisição que retorna um erro não é cobrada. Uma tarefa que falha é 0, porque a Meshy a reembolsa. Cancelar reembolsa uma tarefa apenas enquanto ela está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream deixa o campo de fora, e uma requisição de listagem retorna 500. Nesse caso, tente a requisição novamente.

URLs de download para a imagem conceitual. O array tem uma URL depois que a tarefa é bem-sucedida, e fica vazio até então.

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

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

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

O status da tarefa.

Valores disponíveis:

• PENDING: aguardando na fila
• IN_PROGRESS: gerando o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

Porcentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando ela é 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é então.

Hora em que a tarefa atingiu um status final, em milissegundos Unix. null até então.

Hora em que o resultado da tarefa expira, em milissegundos Unix. São 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. Veja Retenção de recursos.

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

Por que a tarefa falhou. null a menos que status seja FAILED. Veja Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Uma requisição que retorna um erro não é cobrada. Uma tarefa que falha é 0, porque a Meshy a reembolsa. Cancelar reembolsa uma tarefa apenas enquanto ela está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream deixa o campo de fora, e uma requisição de listagem retorna 500. Nesse caso, tente novamente a requisição.

Sempre "" para uma tarefa de build de figura.

Sempre "" para uma tarefa de build de figura, assim como prompt.

Sempre "" para uma tarefa de build de figura, assim como prompt.

Sempre "" para uma tarefa de build de figura, assim como prompt.

URLs de download para o modelo 3D, como um GLB texturizado e como um arquivo OBJ com seu arquivo MTL.

URL de download 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.