Creative Lab — API de Figura

Fotografia de origem para a Meshy estilizar como uma figura chibi. Atualmente suportamos os formatos .jpg, .jpeg, .png e .webp.

Existem duas formas de fornecer a imagem:

• URL publicamente acessível: Um URL que é acessível a partir da internet pública.
• Data URI: Um data URI da imagem codificado em base64. Exemplo de um data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Nome de tarefa opcional para fins de apresentação. Máximo de 100 carateres.

Quando definido como true, a imagem do protótipo é devolvida como um PNG RGBA transparente com o fundo removido, permitindo compor o sujeito sobre qualquer fundo.

O pedido foi inaceitável. Causas comuns:

• Parâmetro em falta: image_url é obrigatório.
• Formato de imagem inválido: O image_url fornecido não está num formato suportado (.jpg, .jpeg, .png, .webp).
• Dimensões da imagem fora do intervalo: A imagem é demasiado pequena, excede o tamanho máximo de ficheiro ou excede a contagem máxima de píxeis.
• URL inacessível: Não foi possível transferir o image_url (404 ou timeout).
• Data URI inválido: A cadeia base64 está mal formada.
• Conteúdo assinalado: A imagem de entrada foi assinalada pela moderation de conteúdo NSFW ou de propriedade intelectual.

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

Créditos insuficientes para realizar esta tarefa.

Excedeu o seu limite de taxa.

O ID de tarefa de uma tarefa de protótipo criada através deste mesmo endpoint OpenAPI. O protótipo deve ter sido criado com a mesma chave de API, deve ter atingido SUCCEEDED e deve ter produzido exatamente uma imagem candidata.

As tarefas de protótipo criadas através da webapp não são aceites — o endpoint de build aceita apenas tarefas de protótipo produzidas por POST /openapi/creative-lab/figure/v1/prototype e recusa qualquer outra origem com 404.

Nome de tarefa opcional para fins de exibição. Máximo de 100 caracteres.

O pedido não foi aceite. Causas comuns:

• Parâmetro em falta: input_task_id é obrigatório.
• UUID inválido: O input_task_id não é um UUID válido.
• Origem ainda não concluída: A tarefa de protótipo referenciada ainda não atingiu SUCCEEDED.
• Sem candidato: A tarefa de protótipo foi bem-sucedida, mas não produziu nenhuma imagem candidata.

Falha na autenticação. Verifique a sua chave de API.

Créditos insuficientes para realizar esta tarefa.

A tarefa de protótipo referenciada não existe, pertence a outro utilizador, ou foi criada através da webapp (apenas as tarefas de protótipo em modo API se encadeiam na construção).

Excedeu o seu limite de taxa.

Identificador único da tarefa de figura a obter.

Identificador único da tarefa de figura a cancelar.

A tarefa já se encontra num estado terminal e não pode ser cancelada.

A tarefa não existe, pertence a um utilizador diferente, ou a sua fase não corresponde ao caminho do URL.

Identificador único da tarefa de figure a transmitir em stream.

prototype ou build. A coleção devolve apenas tarefas cuja etapa corresponda ao URL — pedir /prototype nunca devolve tarefas de construção e vice-versa.

Número da página para paginação.

Limite do tamanho da página. O máximo permitido é 100 itens.

Campo pelo qual ordenar. Valores disponíveis:

• +created_at: Ordena por hora de criação em ordem crescente.
• -created_at: Ordena por hora de criação em ordem decrescente.

Identificador único da tarefa. Embora utilizemos um UUID k-sortable para os ids de tarefa como detalhe de implementação, não deve fazer nenhuma suposição sobre o formato do id.

Tipo da tarefa. O valor é creative-lab-figure-prototype.

O nome da tarefa fornecido no momento da criação. Cadeia vazia se não tiver sido fornecido nenhum nome.

Estado da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa for bem-sucedida, esta passará a 100.

Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.

Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0.

Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos. Se a tarefa ainda não tiver sido concluída, esta propriedade será 0.

Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.

A contagem de tarefas precedentes.

Detalhes de 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. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

URLs transferíveis para os candidatos a imagem de conceito gerados por esta tarefa de protótipo. Atualmente, a API devolve sempre exatamente um candidato; o campo é uma matriz para que futuras revisões possam apresentar múltiplos candidatos sem alterações incompatíveis.

Identificador único da tarefa.

Tipo da tarefa. O valor é creative-lab-figure-build.

O nome da tarefa fornecido no momento da criação da tarefa. String vazia se não tiver sido fornecido um nome.

Estado da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progresso da tarefa. Se a tarefa ainda não tiver começado, esta propriedade será 0. Assim que a tarefa for bem-sucedida, passará a 100.

Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.

Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos.

Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos.

Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.

A contagem de tarefas precedentes. Só tem significado quando o estado é PENDING.

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. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

Sempre vazio para figure build. Presente para compatibilidade entre endpoints com a estrutura partilhada V2ImageTo3DTaskResponse usada por Imagem para 3D.

Sempre vazio para figure build. Presente para compatibilidade entre endpoints.

Sempre vazio para figure build. Presente para compatibilidade entre endpoints.

Sempre vazio para figure build. Presente para compatibilidade entre endpoints.

URLs para transferência do modelo 3D gerado. O figure build produz um GLB texturizado, além do par OBJ + MTL para pipelines que preferem o Wavefront OBJ. A estrutura do campo corresponde ao objeto model_urls do Imagem para 3D, pelo que futuras adições de formato se encaixam sem alterações disruptivas.

URL para transferência da imagem de miniatura do ficheiro do modelo.

Uma matriz de objetos de URL de textura gerados por esta tarefa. Atualmente contém um único objeto com o mapa de cor base.