Transforme um prompt de texto ou uma foto de origem em uma cúpula de luminária
imprimível em 3D em duas etapas: protótipo gera uma imagem conceitual
estilizada em branco fosco, depois construção transforma essa imagem
conceitual em uma cúpula de luminária STL oca (opcionalmente emparelhada com
um disco de base para um suporte de fonte de luz). As duas etapas estão
vinculadas via input_task_id.
Gere uma única imagem conceitual em branco fosco para o abajur — seja a partir de um prompt de texto (texto-para-3D) ou de uma foto de referência (imagem-para-3D). O ID da tarefa retornada é o que você passa como input_task_id para o endpoint de construção. Consulte
O Objeto de Tarefa de Protótipo de Luminária
para o formato da resposta.
Parâmetros
Exatamente um de text ou image_url é obrigatório. Passar ambos, ou nenhum, retorna 400.
Name
text
Type
string
Obrigatório
Description
Prompt de texto descrevendo o assunto desejado para o abajur. Obrigatório quando image_url é omitido. Máximo de 800 caracteres.
Name
image_url
Type
string
Obrigatório
Description
Foto de origem que a Meshy usa como referência visual para o abajur. Obrigatório quando text é omitido. Atualmente suportamos os formatos .jpg, .jpeg, .png e .webp.
Existem duas maneiras de fornecer a imagem:
URL publicamente acessível: Um URL acessível da internet pública.
Data URI: Um Data URI codificado em base64 da imagem. Exemplo de um Data URI: data:image/jpeg;base64,<seus dados de imagem codificados em base64>.
Name
image_subject
Type
string
padrão character
Description
Dica de categoria de assunto para o caminho imagem-para-3D. Valores disponíveis:
character (padrão) — assunto de personagem/objeto único (figura, animal, mascote, etc.).
landscape — assunto de cena ao ar livre/panorama (montanha, paisagem urbana, floresta, etc.).
Ignorado no caminho texto-para-3D.
Name
name
Type
string
Description
Nome opcional da tarefa para fins de exibição. Máximo de 100 caracteres.
Name
remove_background
Type
boolean
padrão false
Description
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 em qualquer fundo.
Retornos
A propriedade result da resposta contém o ID da tarefa id da nova tarefa de protótipo de luminária criada. Consulte o endpoint Obter uma Tarefa ou assine o stream até que a tarefa atinja SUCCEEDED, então passe esse ID para o endpoint de construção como input_task_id.
Modos de Falha
Name
400 - Bad Request
Description
A solicitação foi inaceitável. Causas comuns:
Parâmetro ausente: Exatamente um de text ou image_url é obrigatório.
Ambos fornecidos: Passar ambos text e image_url é rejeitado — eles são mutuamente exclusivos.
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 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 moderação NSFW ou de propriedade intelectual.
Texto muito longo: text excede 800 caracteres.
image_subject inválido: Não é um de character / landscape.
Name
401 - Unauthorized
Description
A autenticação falhou. Por favor, verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
429 - Too Many Requests
Description
Você excedeu seu limite de taxa.
Solicitação
POST
/openapi/creative-lab/lamp/v1/prototype
# Stage 1 (image-to-3D): generate a matte-white lampshade concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "image_subject": "character" }'# Stage 1 (text-to-3D): generate from a text promptcurlhttps://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "text": "a stylized owl perched on a tree branch under moonlight" }'
Resposta
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Exemplo de Protótipo
Comece com uma foto de origem, depois gere a imagem do protótipo usada pelo estágio de construção da luminária.
Gere a cúpula de luminária final, imprimível em 3D, a partir de uma tarefa de protótipo bem-sucedida. A construção executa um pipeline de imagem para 3D na imagem conceitual do protótipo, depois pós-processa a malha através do processador de luminária para ocar, achatar o topo, opcionalmente cortar uma base e (quando um preset de fixação é escolhido) emitir um disco de base separado para a fonte de luz. Consulte O Objeto de Tarefa de Construção de Luminária para o formato da resposta.
Parâmetros
Name
input_task_id
Type
string
Obrigatório
Description
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 do aplicativo web não são aceitas — o endpoint de construção aceita apenas tarefas de protótipo produzidas por POST /openapi/creative-lab/lamp/v1/prototype e recusa qualquer outra fonte com 404.
Name
name
Type
string
Description
Nome opcional da tarefa para fins de exibição. Máximo de 100 caracteres.
options
Parâmetros de ajuste opcionais para a geometria da cúpula da luminária. Cada campo tem um padrão sensato — envie apenas aqueles que você deseja substituir.
Name
diameter_mm
Type
number
padrão 80
Description
Dimensão máxima alvo da caixa delimitadora da cúpula da luminária, em milímetros. A malha é escalada uniformemente para caber. Intervalo: [50, 400].
Name
thickness_mm
Type
number
padrão 1.5
Description
Espessura de parede da cúpula da luminária oca, em milímetros. Intervalo: (0, 10].
Name
cut_amount_percent
Type
number
padrão 35
Description
Percentual da altura da cúpula da luminária a ser achatado no topo para que a impressão possa ficar na base. Intervalo: [1, 100].
Name
light_source_preset
Type
string
padrão bambu_mh001_60mm
Description
Preset de fixação da fonte de luz que determina se (e qual) disco de base emitir junto com a cúpula da luminária. Valores disponíveis:
bambu_mh001_60mm (padrão) — emite um disco de base de 60 mm dimensionado para uma fixação de fonte de luz compatível. O resultado inclui model_urls.base_stl.
none — sem fixação, sem disco de base. model_urls.base_stl é omitido.
Name
fixture_offset_x_mm
Type
number
padrão 0
Description
Deslocamento horizontal no eixo X do recorte da fixação em relação ao centro da cúpula da luminária, em milímetros. Apenas significativo quando light_source_preset ≠ none. Intervalo: [-80, 80].
Name
fixture_offset_z_mm
Type
number
padrão 0
Description
Deslocamento vertical no eixo Z do recorte da fixação em relação à base da cúpula da luminária, em milímetros. Intervalo: [-80, 80].
Name
rotate_x_deg
Type
number
padrão 0
Description
Rotação ao redor do eixo X aplicada à malha importada antes do processamento, em graus. Intervalo: [-360, 360].
Name
rotate_y_deg
Type
number
padrão 0
Description
Rotação ao redor do eixo Y aplicada à malha importada antes do processamento, em graus. Intervalo: [-360, 360].
Name
rotate_z_deg
Type
number
padrão 0
Description
Rotação ao redor do eixo Z aplicada à malha importada antes do processamento, em graus. Intervalo: [-360, 360].
Name
include_result_json
Type
boolean
padrão false
Description
Quando true e output.format é zip, inclui o result.json do processador de luminária (contendo métricas de malha medidas + o conjunto de opções resolvido) dentro do pacote. Ignorado quando output.format é stl.
output
Seletor de formato de fio opcional. O padrão é stl.
Name
format
Type
string
padrão stl
Description
Pacote de artefatos retornado pela construção. Valores disponíveis:
stl (padrão) — retorna a cúpula da luminária como model_urls.lamp_stl, além de model_urls.base_stl quando light_source_preset ≠ none.
zip — empacota todos os artefatos emitidos pelo processador (lamp.stl, base.stl opcional, result.json opcional) em um único zip e o retorna sob model_urls.bundle_zip.
Retornos
A propriedade result da resposta contém o id da tarefa da nova tarefa de construção de luminária criada. Consulte o endpoint Obter uma Tarefa ou assine o stream até que a tarefa alcance SUCCEEDED, então baixe os artefatos de model_urls.
Modos de Falha
Name
400 - Bad Request
Description
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.
Pai não sucedido: A tarefa de protótipo referenciada ainda não alcançou SUCCEEDED.
Sem candidato: A tarefa de protótipo teve sucesso, 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.
Name
401 - Unauthorized
Description
A autenticação falhou. Por favor, verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
404 - Not Found
Description
A tarefa de protótipo referenciada não existe, pertence a um usuário diferente ou foi criada através do aplicativo web (apenas tarefas de protótipo em modo API encadeiam na construção).
Recupere uma tarefa de protótipo ou construção fornecendo um id de tarefa válido. O caminho da URL
deve corresponder ao estágio da tarefa — uma tarefa de construção buscada através de
/prototype/:id retorna 404, e vice-versa.
Cancelar uma tarefa de luminária. Se a tarefa ainda estiver PENDING, os créditos consumidos no momento da criação são reembolsados. Tarefas que já estão IN_PROGRESS são canceladas sem reembolso (o trabalhador pode já estar consumindo recursos). Tarefas que já atingiram um estado terminal (SUCCEEDED, FAILED, CANCELED) não podem ser canceladas.
O caminho da URL deve corresponder ao estágio da tarefa — DELETE em
/prototype/:buildId retorna 404.
Parâmetros de Caminho
Name
id
Type
path
Description
Identificador único para a tarefa de luminária a ser cancelada.
Retornos
Retorna 204 No Content em caso de sucesso com um corpo vazio.
Modos de Falha
Name
400 - Bad Request
Description
A tarefa já está em um estado terminal e não pode ser cancelada.
Name
404 - Not Found
Description
A tarefa não existe, pertence a um usuário diferente ou seu estágio não corresponde ao caminho da URL.
Transmita atualizações em tempo real para uma tarefa de luminária via Server-Sent Events (SSE).
O caminho da URL deve corresponder ao estágio da tarefa — abrir uma transmissão em
/prototype/:buildId/stream emite um único event: error payload com
status_code: 404 e fecha a transmissão.
Parâmetros
Name
id
Type
path
Description
Identificador único para a tarefa de luminária a ser transmitida.
Retornos
Retorna uma transmissão de objetos de tarefa Protótipo de Luminária
ou Construção de Luminária como
Server-Sent Events. Para tarefas PENDING ou IN_PROGRESS, a transmissão de resposta
incluirá apenas os campos necessários progress e status.
// Error event example (wrong stage or task not found)event: errordata: {"status_code": 404,"message": "Task not found"}// Message event examples illustrate task progress.// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-lamp-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 30,"model_urls": {"lamp_stl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***","base_stl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***" }}
Recupere uma lista paginada de suas tarefas de luminária para um único estágio. O caminho da URL seleciona o estágio — /prototype retorna tarefas de protótipo; /build retorna tarefas de construção. Tarefas do outro estágio não estão incluídas em nenhuma das respostas.
Parâmetros de Caminho
Name
stage
Type
path
Obrigatório
Description
Ou prototype ou build. A coleção retorna apenas tarefas cujo estágio corresponde à URL — buscar /prototype nunca retorna tarefas de construção e vice-versa.
Parâmetros de Consulta
Name
page_num
Type
integer
padrão 1
Description
Número da página para paginação.
Name
page_size
Type
integer
padrão 10
Description
Limite de tamanho da página. O máximo permitido é 50 itens.
Name
sort_by
Type
string
padrão -created_at
Description
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.
O objeto de tarefa do protótipo de luminária é uma unidade de trabalho que a Meshy acompanha para gerar uma imagem conceitual estilizada em branco fosco a partir de um prompt de texto ou de uma foto de origem. A saída desta etapa é encadeada na etapa de construção via input_task_id.
Propriedades
Name
id
Type
string
Description
Identificador único para a tarefa. Embora usemos um UUID ordenável por k para ids de tarefa como detalhe de implementação, você não deve fazer suposições sobre o formato do id.
Name
type
Type
string
Description
Tipo da tarefa. O valor é creative-lab-lamp-prototype.
Name
name
Type
string
Description
O nome da tarefa fornecido quando a tarefa foi criada. String vazia se nenhum nome foi fornecido.
Name
status
Type
string
Description
Status da tarefa. Os valores possíveis são um dos PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
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, isso se tornará 100.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.
Um carimbo de data/hora representa o número de milissegundos decorridos desde 1º de janeiro de 1970 UTC, seguindo o padrão RFC 3339. Por exemplo, sexta-feira, 1º de setembro de 2023, 12:00:00 PM GMT é representado como 1693569600000. Isso se aplica a todos os carimbos de data/hora na Meshy API.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não foi iniciada, esta propriedade será 0.
Name
finished_at
Type
timestamp
Description
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.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes.
O valor deste campo é significativo apenas se o status da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas falhadas. Veja Erros para a referência completa do objeto task_error.
Name
consumed_credits
Type
integer
Description
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).
Name
image_urls
Type
array of strings
Description
URLs para download dos candidatos a imagem conceitual 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 apresentar múltiplos candidatos sem uma mudança disruptiva.
Exemplo de Objeto de Tarefa do Protótipo de Luminária
O objeto de Tarefa de Construção de Luminária é uma unidade de trabalho que a Meshy acompanha para gerar a cúpula de luminária final imprimível em 3D a partir de uma tarefa de protótipo bem-sucedida. A construção executa um pipeline de imagem para rascunho 3D + textura na imagem conceitual do protótipo, e então pós-processa a malha através do processador de luminária para ocar, achatar e (opcionalmente) cortar uma base de fixação.
Propriedades
Name
id
Type
string
Description
Identificador único para a tarefa.
Name
type
Type
string
Description
Tipo da tarefa. O valor é creative-lab-lamp-build.
Name
name
Type
string
Description
O nome da tarefa fornecido quando a tarefa foi criada. String vazia se nenhum nome foi fornecido.
Name
status
Type
string
Description
Status da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
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, isso se tornará 100.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos.
Name
finished_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes. Significativo apenas quando o status é PENDING.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas falhas. Veja Erros para a referência completa do objeto task_error.
Name
consumed_credits
Type
integer
Description
O número de créditos consumidos por esta tarefa. Retorna 0 para tarefas FAILED (créditos são reembolsados em caso de falha).
Name
model_urls
Type
object
Description
URLs para download dos artefatos gerados, indexados pelo nome do artefato. O conjunto de chaves depende de output.format e options.light_source_preset:
Name
lamp_stl
Type
string
Description
URL para download da cúpula da luminária lamp.stl. Presente quando output.format foi stl (o padrão).
Name
base_stl
Type
string
Description
URL para download da base de fixação base.stl. Presente quando output.format foi stleoptions.light_source_preset não era none. Omitido quando o preset de fixação era none.
Name
bundle_zip
Type
string
Description
URL para download de um pacote zip de todos os artefatos emitidos pelo processador (lamp.stl, base.stl opcional, e — quando options.include_result_json é true — result.json). Presente quando output.format foi zip. Quando bundle_zip está presente, lamp_stl / base_stl são omitidos.
Exemplo de Objeto de Tarefa de Construção de Luminária