Creative Lab — API de Íman de Frigorífico

Fotografia de origem para a Meshy colorizar numa imagem de conceito pronta para íman de frigorífico. 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,<os seus dados de imagem codificados em base64>.

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, para que possa compor o motivo sobre qualquer fundo.

Isto controla apenas a imagem devolvida por este endpoint. É independente da opção de build com o mesmo nome (predefinição true), que controla a remoção do fundo antes do relevo.

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 é um formato suportado (.jpg, .jpeg, .png, .webp).
• Dimensões da imagem fora do intervalo: A imagem é demasiado pequena, excede o tamanho máximo do 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 impróprio (NSFW) ou de propriedade intelectual.

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

Créditos insuficientes para executar esta tarefa.

Excedeu o seu limite de taxa.

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

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

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

Silhueta do contorno do íman de frigorífico. Valores disponíveis:

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

Comprimento da aresta do quadrado delimitador do íman de frigorífico, 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. A predefinição do íman de frigorífico é uma base mais robusta de 2 mm — dá ao íman corpo suficiente para agarrar o frigorífico sem que o relevo pareça frágil. Intervalo: [0, 20].

Se a parte de trás do íman de frigorífico é selada como uma superfície fechada (o lado onde se cola o íman). Defina como false para uma estrutura aberta.

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

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

Parâmetro de forma da curva de transferência (apenas relevante quando relief_curve é gamma). Intervalo: (0, 10].

Inverte a interpretação do mapa de profundidade para que as regiões mais escuras se tornem em 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 de passa-baixo para os valores do mapa de profundidade; tudo abaixo deste valor é reduzido a zero. Intervalo: [0, 1].

Remove automaticamente o fundo da imagem conceptual do protótipo antes do processo de relevo.

Distinto do parâmetro do protótipo com o mesmo nome (predefinição false), que controla se a própria imagem do protótipo é devolvida com transparência.

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

Conjunto de artefactos devolvido pelo build. 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 conjunto em model_urls.obj.
• zip — compacta todos os artefactos emitidos pelo gerador e devolve o conjunto em model_urls.bundle_zip.

O pedido foi inaceitá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.
• Tarefa principal sem sucesso: A tarefa de protótipo referenciada ainda não atingiu SUCCEEDED.
• Sem candidata: A tarefa de protótipo teve sucesso mas não produziu nenhuma imagem candidata.
• Opções fora do intervalo: Um dos campos de options ficou fora do intervalo permitido ou do conjunto de valores enumerados.

A autenticação falhou. 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 tarefas de protótipo em modo API se encadeiam com o build).

Excedeu o seu limite de taxa.

Identificador único da tarefa de íman de frigorífico a obter.

Identificador único da tarefa de íman de frigorífico 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 para a tarefa de íman de frigorífico a transmitir.

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

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

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

Campo pelo qual ordenar. Valores disponíveis:

• +created_at: Ordenar por hora de criação em ordem ascendente.
• -created_at: Ordenar por hora de criação em ordem descendente.

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

Tipo da tarefa. O valor é creative-lab-fridge-magnet-prototype.

O nome da tarefa fornecido no momento da criação da tarefa. 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.

Progresso da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa for bem-sucedida, passará a ser 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 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 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 revisões futuras possam disponibilizar vários candidatos sem introduzir uma alteração disruptiva.

Identificador único da tarefa.

Tipo da tarefa. O valor é creative-lab-fridge-magnet-build.

O nome da tarefa fornecido no momento da criação da tarefa. 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.

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 ser 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ó é relevante quando o estado é PENDING.

Detalhes de erro para tarefas com falha. 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 transferíveis para o artefacto gerado, indexados por nome de artefacto. Contém sempre exatamente uma entrada — o formato solicitado através do output.format do pedido de compilação. A chave corresponde ao formato solicitado: