Creative Lab — API de ímã de geladeira

Foto de origem para o Meshy colorizar em uma imagem de conceito pronta para ímã de geladeira. Atualmente oferecemos suporte aos formatos .jpg, .jpeg, .png e .webp.

Há duas maneiras de fornecer a imagem:

• URL publicamente acessível: Uma URL que é acessível pela internet pública.
• Data URI: Um data URI da imagem codificado em base64. Exemplo de um data URI: data:image/jpeg;base64,<seus dados de imagem codificados em base64>.

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

Quando definido como true, a imagem do protótipo é retornada como um PNG RGBA transparente com o fundo removido, para que você possa compor o assunto sobre qualquer plano de fundo.

Isso controla apenas a imagem retornada por este endpoint. É separado da opção de build de mesmo nome (padrão true), que controla a remoção do fundo antes do relevo (reliefing).

A solicitação foi inaceitável. Causas comuns:

• Parâmetro ausente: image_url é obrigatório.
• Formato de imagem inválido: O image_url fornecido não está em um formato suportado (.jpg, .jpeg, .png, .webp).
• Dimensões de imagem fora do intervalo: A imagem é muito pequena, excede o tamanho máximo de arquivo ou excede a contagem máxima de pixels.
• URL inacessível: O image_url não pôde ser baixado (404 ou timeout).
• Data URI inválido: A string base64 está malformada.
• Conteúdo sinalizado: A imagem de entrada foi sinalizada por moderation de conteúdo adulto (NSFW) ou de propriedade intelectual.

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

Créditos insuficientes para realizar esta tarefa.

Você excedeu seu limite de taxa.

O ID da tarefa de uma tarefa de protótipo criada por meio 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 por meio do webapp não são aceitas — o endpoint de construção aceita apenas tarefas de protótipo produzidas por POST /openapi/creative-lab/fridge-magnet/v1/prototype e recusa qualquer outra origem com 404.

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

Silhueta de contorno do ímã de geladeira. Valores disponíveis:

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

Comprimento da aresta do quadrado delimitador do ímã de geladeira, 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 base plana atrás do relevo, em milímetros. O padrão do ímã de geladeira é uma base mais robusta de 2 mm — o que dá ao ímã corpo suficiente para se fixar na geladeira sem que o relevo pareça frágil. Intervalo: [0, 20].

Se a parte de trás do ímã de geladeira é selada como uma superfície fechada (o lado onde você cola o ímã). Defina como false para uma casca aberta.

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

• linear (padrão)
• gamma
• s-curve

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

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

Força 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-baixa para os valores do mapa de profundidade; qualquer valor abaixo disso é fixado em zero. Intervalo: [0, 1].

Remove automaticamente o fundo da imagem de conceito do protótipo antes de aplicar o relevo.

Independente do parâmetro de mesmo nome do protótipo (padrão false), que controla se a própria imagem do protótipo é retornada com transparência.

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

Pacote de artefatos retornado pela construção. Valores disponíveis:

• glb (padrão) — retorna um único model.glb em model_urls.glb.
• obj — compacta model.obj + model.mtl + texture.png e retorna o pacote em model_urls.obj.
• zip — compacta todos os artefatos que o gerador produz e retorna o pacote em model_urls.bundle_zip.

A solicitação foi inaceitável. Causas comuns:

• Parâmetro ausente: input_task_id é obrigatório.
• UUID inválido: O input_task_id não é um UUID válido.
• Tarefa pai não concluída: A tarefa de protótipo referenciada ainda não atingiu SUCCEEDED.
• Sem candidato: A tarefa de protótipo teve sucesso, mas não produziu nenhuma imagem candidata.
• Opções fora do intervalo: Um dos campos de options estava fora do intervalo permitido ou do conjunto de valores enumerados.

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

Créditos insuficientes para executar esta tarefa.

A tarefa de protótipo referenciada não existe, pertence a um usuário diferente, ou foi criada por meio do webapp (somente tarefas de protótipo em modo API se encadeiam com a construção).

Você excedeu seu limite de taxa.

Identificador único da tarefa de ímã de geladeira a ser recuperada.

Identificador único da tarefa de ímã de geladeira a ser cancelada.

A tarefa já está em um estado terminal e não pode ser cancelada.

A tarefa não existe, pertence a outro usuário, ou seu estágio não corresponde ao caminho da URL.

Identificador único da tarefa de ímã de geladeira a ser transmitida via streaming.

prototype ou build. A coleção retorna apenas as tarefas cujo estágio corresponda à URL — buscar em /prototype nunca retorna tarefas de build 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 horário de criação em ordem crescente.
• -created_at: Ordenar por horário de criação em ordem decrescente.

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

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

O nome da tarefa fornecido quando a tarefa foi criada. String vazia se nenhum nome foi fornecido.

Status 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 foi iniciada, esta propriedade será 0. Assim que a tarefa for concluída com sucesso, ela se tornará 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 foi iniciada, esta propriedade será 0.

Carimbo de data/hora de quando a tarefa foi finalizada, em milissegundos. Se a tarefa ainda não foi finalizada, 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 com falha. Consulte Erros para a referência completa do objeto task_error.

O número de créditos consumidos por esta tarefa. Presente quando o status da tarefa é PENDING, IN_PROGRESS, ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

URLs para download dos candidatos a imagem de conceito gerados por esta tarefa de protótipo. Atualmente a API sempre retorna exatamente um candidato; o campo é um array para que revisões futuras possam expor múltiplos candidatos sem uma alteração significativa (breaking change).

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. String vazia se nenhum nome foi fornecido.

Status 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 foi iniciada, esta propriedade será 0. Assim que a tarefa for bem-sucedida, ela se tornará 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 finalizada, em milissegundos.

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

A contagem de tarefas precedentes. Significativo apenas quando o status é 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. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

URLs para download do artefato gerado, indexadas pelo nome do artefato. Sempre contém exatamente uma entrada — o formato solicitado através do output.format da requisição de build. A chave corresponde ao formato solicitado: