Creative Lab — API de porta-chaves

Fotografia de origem para a Meshy colorizar numa imagem de conceito pronta para porta-chaves. Atualmente, suportamos os formatos .jpg, .jpeg, .png e .webp.

Existem duas formas de fornecer a imagem:

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

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

O pedido não foi aceite. 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 descarregar o image_url (404 ou timeout).
• Data URI inválido: A string base64 está malformada.
• Conteúdo sinalizado: A imagem de entrada foi sinalizada por moderation 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.

Tarefas de protótipo criadas através da aplicação Web não são aceites — o endpoint de construção aceita apenas tarefas de protótipo produzidas por POST /openapi/creative-lab/keychain/v1/prototype e recusa qualquer outra origem com 404.

Nome opcional da tarefa para efeitos de apresentação. Máximo de 100 caracteres.

Silhueta do contorno do medalhão de porta-chaves. Valores disponíveis:

• circle (predefinição)
• rounded-rect
• hexagon
• shield
• star

Comprimento da aresta do quadrado delimitador do porta-chaves, em milímetros. Intervalo: (0, 400].

Altura máxima do relevo acima da base, em milímetros. Intervalo: [0, 20].

Deslocamento vertical aplicado ao relevo antes da extrusão, em milímetros. Intervalo: [0, 20].

Espessura da placa de base plana por trás do relevo, em milímetros. Intervalo: [0, 20].

Se a parte traseira do medalhão é selada como uma superfície fechada. Defina como false para uma concha aberta.

Curva de transferência que mapeia valores do mapa de profundidade para a altura do relevo. Valores disponíveis:

• linear (predefinição)
• gamma
• s-curve

parâmetro de forma para a curva de transferência (apenas significativo quando relief_curve é gamma). Intervalo: (0, 10].

Inverta a interpretação do mapa de profundidade para que as regiões mais escuras se tornem relevo mais alto.

Intensidade de suavização aplicada ao mapa de profundidade antes da extração do relevo. Intervalo: [0, 10].

Multiplicador de escala vertical aplicado sobre relief_height_mm. Intervalo: (0, 10].

Limiar passa-baixo para valores do mapa de profundidade; tudo abaixo deste valor é limitado a zero. Intervalo: [0, 1].

Remover automaticamente o fundo da imagem de conceito do protótipo antes de criar o relevo.

Resolução da malha usada para exportação. Intervalo: [64, 2048].

Pacote de artefactos devolvido pela construção. Valores disponíveis:

• glb (predefinição) — devolve um único model.glb em model_urls.glb.
• obj — compacta model.obj + model.mtl + texture.png e devolve o pacote em model_urls.obj.
• zip — compacta todos os artefactos que o gerador emite e devolve o pacote em model_urls.bundle_zip.

O pedido não era aceitável. Causas comuns:

• Parâmetro em falta: input_task_id é obrigatório.
• UUID inválido: O input_task_id não é um UUID válido.
• Elemento principal não bem-sucedido: 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.
• Opções fora do intervalo: Um dos campos de options ficou fora do respetivo intervalo permitido ou conjunto enumerado.

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

Créditos insuficientes para executar esta tarefa.

A tarefa de protótipo referenciada não existe, pertence a um utilizador diferente ou foi criada através da aplicação Web (apenas tarefas de protótipo em mode API encadeiam para a construção).

Excedeu o seu limite de taxa.

Identificador único da tarefa de porta-chaves a obter.

Identificador único da tarefa de porta-chaves 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 respetiva etapa não corresponde ao caminho do URL.

Identificador único da tarefa de porta-chaves a transmitir em fluxo.

prototype ou build. A coleção devolve apenas tarefas cuja fase corresponde ao URL — obter /prototype nunca devolve tarefas de build e vice-versa.

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

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

Campo pelo qual ordenar. Valores disponíveis:

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

Identificador único da tarefa. Embora utilizemos um UUID ordenável por k para os ids das tarefas como detalhe de implementação, não deve fazer quaisquer pressupostos sobre o formato do id.

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

O nome da tarefa fornecido quando a tarefa foi criada. String 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 tiver sido concluída com sucesso, 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 terminada, em milissegundos. Se a tarefa ainda não tiver terminado, esta propriedade será 0.

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

A contagem das tarefas precedentes.

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

URLs transferíveis para as imagens de conceito candidatas geradas por esta tarefa de protótipo. Atualmente, a API devolve sempre exatamente uma candidata; o campo é uma matriz para que futuras revisões possam disponibilizar várias candidatas sem uma alteração incompatível.

Identificador único da tarefa.

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

O nome da tarefa fornecido quando a tarefa foi criada. 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, 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.

O número de tarefas anteriores. Significativo apenas 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).

URLs de descarregamento para o artefacto gerado, indexados pelo nome do artefacto. Contém sempre exatamente uma entrada — o formato solicitado através de output.format do pedido de compilação. A chave corresponde ao formato solicitado: