Creative Lab — API do Candeeiro

Foto de origem que a Meshy usa como referência visual para o abajur. Atualmente suportamos os formatos .jpg, .jpeg, .png e .webp.

Existem duas formas de fornecer a imagem:

• URL publicamente acessível: Um URL 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>.

Sugestão de categoria de assunto que seleciona o prompt de stylization. Valores disponíveis:

• character (predefinição) — assunto de personagem/objeto único (figura, animal, mascote, etc.).
• landscape — assunto de cena exterior/panorama (montanha, paisagem urbana, floresta, etc.).

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

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

O pedido era 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 string base64 está mal formada.
• Conteúdo assinalado: A imagem de entrada foi assinalada por moderation de conteúdo NSFW ou de propriedade intelectual.
• image_subject inválido: Não é character nem landscape.

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 da 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 um modelo 3D.

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/lamp/v1/prototype e recusa qualquer outra origem com 404.

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

Dimensão máxima alvo da caixa delimitadora da campânula do candeeiro, em milímetros. A malha é escalada uniformemente para se ajustar. Intervalo: [50, 400].

Espessura de parede da campânula oca do candeeiro, em milímetros. Intervalo: (0, 10].

Percentagem da altura do modelo cortada de forma plana na base, para que a campânula do candeeiro assente na mesa de impressão e tenha uma abertura para a fixture. Intervalo: [1, 100].

Preset de fixture da fonte de luz que determina como a base é construída. Valores disponíveis:

• bambu_mh001_60mm (predefinição) — campânula de candeeiro com base aberta mais uma placa de base com um orifício de fixture de 60 mm, ambos em model_urls.lamp_stl, e o suporte da fixture como model_urls.base_stl.
• none — uma única campânula de candeeiro selada em model_urls.lamp_stl; model_urls.base_stl é omitido.

Deslocamento no eixo X do orifício da fixture na placa de base, em relação ao centro da campânula do candeeiro, em milímetros. Só é relevante quando light_source_preset ≠ none. Intervalo: [-80, 80].

Deslocamento no eixo Z (profundidade) do orifício da fixture na placa de base, em relação ao centro da campânula do candeeiro, em milímetros. Só é relevante quando light_source_preset ≠ none. Intervalo: [-80, 80].

Rotação em torno do eixo X aplicada ao modelo antes do processamento, em graus. As três rotações são aplicadas como ângulos de Euler XYZ em torno do centro do modelo. Intervalo: [-360, 360].

Rotação em torno do eixo Y aplicada à malha importada antes do processamento, em graus. Intervalo: [-360, 360].

Rotação em torno do eixo Z aplicada à malha importada antes do processamento, em graus. Intervalo: [-360, 360].

Quando true e output.format é zip, inclui o result.json do processador de candeeiro (nome do pipeline, avisos e caminhos dos artefactos) dentro do pacote. Ignorado quando output.format é stl.

Pacote de artefactos devolvido pelo build. Valores disponíveis:

• stl (predefinição) — devolve model_urls.lamp_stl (a campânula do candeeiro, juntamente com a placa de base quando um preset de fixture está definido), mais model_urls.base_stl quando light_source_preset ≠ none.
• zip — empacota todos os artefactos que o processador produz (lamp.stl, base.stl opcional, result.json opcional) num único zip e devolve-o em model_urls.bundle_zip.

O pedido era inaceitável. Causas comuns:

• Parâmetro em falta: input_task_id é obrigatório.
• UUID inválido: input_task_id não é um UUID válido.
• Origem não bem-sucedida: A tarefa de protótipo referenciada ainda não atingiu SUCCEEDED.
• Sem modelo: A tarefa de protótipo foi bem-sucedida mas não produziu um modelo 3D.
• Opções fora do intervalo: Um dos campos de options está fora do intervalo permitido ou do conjunto de valores enumerados.

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

Créditos insuficientes para executar 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 para build).

Excedeu o seu limite de taxa.

Identificador único da tarefa de candeeiro a obter.

Identificador único da tarefa de candeeiro 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 candeeiro a fazer stream.

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

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

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

Campo pelo qual ordenar. Valores disponíveis:

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

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

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

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

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. 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 para download do modelo 3D gerado a partir da imagem conceptual. Presente assim que a tarefa for bem-sucedida; {} antes disso.

URL para download de uma pré-visualização renderizada do modelo 3D. String vazia até a tarefa ser bem-sucedida.

URLs para download das imagens conceptuais candidatas geradas por esta tarefa de protótipo. Atualmente, a API devolve sempre exatamente um candidato; o campo é um array para que futuras revisões possam apresentar múltiplos candidatos sem introduzir uma alteração significativa (breaking change).

Identificador único da tarefa.

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

O nome da tarefa fornecido quando a tarefa foi criada. Cadeia de caracteres 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, este valor 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ó 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).

URLs transferíveis para os artefactos gerados, indexados pelo nome do artefacto. O conjunto de chaves depende de output.format e options.light_source_preset: