Creative Lab — API de Íman de Frigorífico

Foto de origem para a Meshy colorir numa imagem conceptual pronta para íman de frigorífico. Atualmente, suportamos os formatos .jpg, .jpeg, .png e .webp.

Existem duas maneiras de fornecer a imagem:

• URL publicamente acessível: Um URL 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 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 possa compor o sujeito em qualquer fundo.

Isto controla apenas a imagem que este endpoint retorna. É separado da opção de construção com o mesmo nome (padrã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 é muito pequena, excede o tamanho máximo do ficheiro ou excede o número máximo de píxeis.
• URL inacessível: O image_url não pôde ser descarregado (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. Por favor, verifique a sua chave de API.

Créditos insuficientes para realizar 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 deve ter sido criado com a mesma chave de API, deve ter alcançado 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/fridge-magnet/v1/prototype e recusa qualquer outra fonte com 404.

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

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

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

Comprimento da borda 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 base plana atrás do relevo, em milímetros. O padrão do íman de frigorífico é uma base mais espessa de 2 mm — dá ao íman corpo suficiente para aderir ao frigorífico sem que o relevo pareça frágil. Intervalo: [0, 20].

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

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

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

Parâmetro de forma para a curva de transferência (apenas significativo 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].

Limite de passagem baixa para valores de mapa de profundidade; qualquer valor abaixo disso é fixado a zero. Intervalo: [0, 1].

Remove automaticamente o fundo da imagem conceitual do protótipo antes do relevo.

Separado do parâmetro de protótipo com o mesmo nome (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 sob model_urls.glb.
• obj — compacta model.obj + model.mtl + texture.png e retorna o pacote sob model_urls.obj.
• zip — compacta todos os artefatos que o gerador emite e retorna o pacote sob 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.
• Pai 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 imagem candidata.
• Opções fora do intervalo: Um dos campos options caiu fora do intervalo permitido ou conjunto de enumeração.

A autenticação falhou. Por favor, verifique a sua chave de API.

Créditos insuficientes para realizar 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 modo API encadeiam na construção).

Excedeu o seu limite de taxa.

Identificador único para a tarefa de íman de frigorífico a recuperar.

Identificador único para a tarefa de íman de frigorífico a cancelar.

A tarefa já está 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.

Ou prototype ou build. A coleção retorna apenas tarefas cuja fase corresponde ao URL — buscar /prototype nunca retorna 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 é 50 itens.

Campo para ordenar. Valores disponíveis:

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

Identificador único para a tarefa. Embora usemos um UUID ordenável por k para os ids de tarefa como detalhe de implementação, não deve fazer quaisquer suposições sobre o formato do id.

Tipo de 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.

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 foi iniciada, esta propriedade será 0. Uma vez que a tarefa tenha sido concluída com sucesso, isto 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 concluída, em milissegundos. Se a tarefa ainda não foi 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. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

URLs descarregáveis para os candidatos a imagem conceptual gerados por esta tarefa protótipo. Atualmente, a API sempre retorna exatamente um candidato; o campo é um array para que revisões futuras possam apresentar múltiplos candidatos sem uma alteração disruptiva.

Identificador único para a tarefa.

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

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

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

Progresso da tarefa. Se a tarefa ainda não foi iniciada, esta propriedade será 0. Uma vez que a tarefa tenha sido bem-sucedida, isto 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 concluída, em milissegundos.

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

A contagem de tarefas precedentes. Significativo apenas quando o estado é PENDING.

Detalhes do erro para tarefas falhadas. Veja 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 artefacto gerado, indexados pelo nome do artefacto. Contém sempre exatamente uma entrada — o formato solicitado através do output.format do pedido de construção. A chave corresponde ao formato solicitado: