A API de Imagem para 3D é um recurso que permite integrar as funcionalidades de Imagem para 3D da Meshy ao seu próprio aplicativo. Nesta seção, você encontrará todas as informações
necessárias para começar a usar esta API.
Este endpoint permite criar uma nova tarefa de Imagem para 3D. Consulte
O objeto de tarefa de Imagem para 3D para ver quais
propriedades estão incluídas no objeto de tarefa de Imagem para 3D.
Parâmetros
Apenas um entre input_task_id ou image_url é obrigatório. Se ambos forem fornecidos, input_task_id terá prioridade.
Name
input_task_id
Type
string
Obrigatório
Description
O ID de uma tarefa de geração de imagem concluída cuja saída deve ser usada como imagem de entrada. Essa tarefa deve ser uma das seguintes tarefas: Texto para imagem ou Imagem para imagem. Além disso, ela deve ter sido executada via API, ter um status de SUCCEEDED e produzir exatamente uma imagem.
Name
image_url
Type
string
Obrigatório
Description
Forneça uma imagem para a Meshy usar na criação do modelo. Atualmente, oferecemos suporte aos formatos .jpg, .jpeg e .png.
Há duas formas de fornecer a imagem:
URL publicamente acessível: Uma URL acessível pela internet pública.
Data URI: Uma Data URI da imagem codificada em base64. Exemplo de uma Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
model_type
Type
string
padrão standard
Description
Especifique o tipo de geração de malha 3D.
Valores disponíveis:
standard: Geração de malha 3D regular com alto nível de detalhe.
lowpoly: Gera uma malha low-poly otimizada para polígonos mais limpos.
Quando lowpoly é selecionado, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model são ignorados.
Name
ai_model
Type
string
padrão latest
Description
ID do modelo a ser usado. Valores disponíveis: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
padrão true
Description
Determina se texturas são geradas. Defini-lo como false ignora a fase de textura, fornecendo uma malha sem texturas.
Aplica-se somente quando should_texture = true
Name
enable_pbr
Type
boolean
padrão false
Description
Gere mapas PBR (metálico, rugosidade, normal), além da cor base. Um mapa de emissão também é incluído quando ai_model é meshy-6 ou latest.
Name
hd_texture
Type
boolean
padrão false
Description
Gere a textura de cor base em resolução 4K (4096×4096) para maior detalhe.
Compatível apenas quando ai_model é meshy-6 ou latest. Os mapas PBR são sempre gerados em 2K.
Name
texture_prompt
Type
string
Description
Forneça um prompt de texto para orientar o processo de texturização. Máximo de 600 caracteres.
Name
texture_image_url
Type
string
Description
Forneça uma imagem 2D para orientar o processo de texturização. Atualmente, oferecemos suporte aos formatos .jpg, .jpeg e .png.
Há duas formas de fornecer a imagem:
URL publicamente acessível: Uma URL acessível pela internet pública
Data URI: Uma Data URI da imagem codificada em base64. Exemplo de uma Data URI: data:image/jpeg;base64,<your base64-encoded image data>
A texturização por imagem pode não funcionar de forma ideal se houver diferenças substanciais de geometria entre o asset original e a imagem enviada. Apenas um entre texture_image_url ou texture_prompt pode ser usado para orientar o processo de texturização. Se ambos os parâmetros forem fornecidos, então texture_prompt será usado para texturizar o modelo por padrão. Texturizar via texto ou imagem custará 10 créditos por tarefa.
Name
should_remesh
Type
boolean
padrão false (meshy-6), true (others)
Description
Controla se a fase de Remesh deve ser habilitada. Quando definido como false, a API retorna a malha triangular de maior precisão.
Aplica-se somente quando should_remesh = true
Name
topology
Type
string
padrão triangle
Description
Especifique a topology do modelo gerado.
Valores disponíveis:
quad: Gera uma malha predominantemente quadrangular.
triangle: Gera uma malha triangular decimada.
Name
target_polycount
Type
integer
padrão 30,000
Description
Especifique o número alvo de polígonos no modelo gerado. O número real de polígonos pode divergir do alvo dependendo da complexidade da geometria.
O intervalo de valores válido varia dependendo do nível do usuário:
100 a 300.000 (inclusive)
Name
decimation_mode
Type
integer
Description
Habilite a decimação adaptativa definindo um nível de contagem de polígonos. Quando definido, target_polycount é ignorado.
Valores disponíveis:
1: Adaptativo — contagem de polígonos ultra.
2: Adaptativo — contagem de polígonos alta.
3: Adaptativo — contagem de polígonos média.
4: Adaptativo — contagem de polígonos baixa.
Name
save_pre_remeshed_model
Type
boolean
padrão false
Description
Quando definido como true, a Meshy também armazena um arquivo GLB extra antes da conclusão da fase de Remesh.
Name
symmetry_mode
Type
string
⚠ obsoleto
padrão auto
Description
Obsoleto (deprecated). Este parâmetro não afeta mais a saída.
O campo symmetry_mode controla o comportamento de simetria durante o processo de geração do modelo.
Os valores válidos são:
off: Desabilita a simetria.
auto: Determina e aplica automaticamente a simetria com base na geometria de entrada.
Use pose_mode em vez disso. Define se o modelo será gerado em uma pose A/T.
Name
image_enhancement
Type
boolean
padrão true
Description
Otimiza a imagem de entrada para obter melhores resultados. Defina como false para preservar a aparência exata da imagem de entrada sem qualquer processamento de estilo.
Compatível apenas quando ai_model é meshy-6 ou latest.
Name
remove_lighting
Type
boolean
padrão true
Description
Remove realces e sombras da textura de cor base, produzindo um resultado mais limpo que funciona melhor em configurações de iluminação personalizadas.
Compatível apenas quando ai_model é meshy-6 ou latest.
Name
moderation
Type
boolean
padrão false
Description
Quando definido como true, o conteúdo de entrada será automaticamente verificado quanto a conteúdo potencialmente prejudicial. Se conteúdo prejudicial for detectado, a tarefa não prosseguirá para a geração.
O conteúdo das entradas image_url, texture_image_url e texture_prompt será verificado.
Name
target_formats
Type
string[]
Description
Especifica quais formatos de arquivo 3D incluir na saída. Somente os formatos solicitados serão gerados e retornados, o que pode reduzir o tempo de conclusão da tarefa. Quando omitido, todos os formatos compatíveis são incluídos.
Quando omitido, todos os formatos exceto 3mf são gerados. 3mf só é incluído quando especificado explicitamente.
Name
auto_size
Type
boolean
padrão false
Description
Quando definido como true, o serviço usa visão por IA para estimar automaticamente a altura real do objeto e redimensionar o modelo de acordo. A origem será definida por padrão como bottom, a menos que origin_at seja definido explicitamente.
Name
alpha_thumbnail
Type
boolean
padrão false
Description
Quando definido como true, a tarefa renderiza adicionalmente uma versão com fundo transparente (RGBA) da pré-visualização e a retorna como alpha_thumbnail_url na resposta GET. O campo thumbnail_url existente permanece inalterado.
Name
multi_view_thumbnails
Type
boolean
padrão false
Description
Quando definido como true, a tarefa renderiza adicionalmente quatro miniaturas em vistas cardinais (frente, direita, trás, esquerda) e as retorna em thumbnail_urls na resposta GET. O campo thumbnail_url existente permanece inalterado e continua apontando para a vista frontal, portanto os clientes existentes não são afetados.
Adiciona aproximadamente 3 segundos à latência da tarefa.
Aplica-se somente quando auto_size = true
Name
origin_at
Type
string
padrão bottom
Description
Posição da origem quando auto_size está habilitado.
Valores disponíveis: bottom, center.
Retorna
A propriedade result da resposta contém o id da tarefa de Imagem para 3D recém-criada.
Modos de falha
Name
400 - Bad Request
Description
A solicitação era inaceitável. Causas comuns:
Parâmetro ausente: image_url ou input_task_id deve ser fornecido.
Tarefa de entrada inválida: O input_task_id deve se referir a uma tarefa de Texto para imagem ou Imagem para imagem com SUCCEEDED que produza exatamente uma imagem.
Formato de imagem inválido: O image_url fornecido não está em um formato compatível (.jpg, .jpeg, .png).
URL inacessível: Não foi possível baixar o image_url (404 ou timeout).
Data URI inválida: A string base64 está malformada.
Combinação de parâmetros inválida: enable_pbr é compatível apenas quando should_texture é true.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para executar esta tarefa.
Name
429 - Too Many Requests
Description
Você excedeu seu limite de taxa.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Este endpoint permite recuperar uma tarefa de Imagem para 3D fornecendo um id de tarefa válido.
Consulte O objeto de tarefa de Imagem para 3D para ver quais
propriedades estão incluídas no objeto de tarefa de Imagem para 3D.
Parâmetros
Name
id
Type
path
Description
Identificador único da tarefa de Imagem para 3D a ser recuperada.
O objeto de Tarefa de Imagem para 3D é uma unidade de trabalho que a Meshy acompanha para gerar um modelo 3D a partir de uma entrada de imagem.
O objeto tem as seguintes propriedades:
Propriedades
Name
id
Type
string
Description
Identificador único da tarefa. Embora usemos um UUID k-ordenável para ids de tarefa como
detalhe de implementação, você não deve fazer nenhuma suposição sobre o formato do id.
Name
type
Type
string
Description
Tipo da tarefa Imagem para 3D. O valor é image-to-3d.
Name
model_urls
Type
object
Description
URL para download do arquivo de modelo 3D texturizado gerado pela Meshy. A propriedade de um formato será omitida se o formato não for gerado, em vez de retornar uma string vazia.
Name
glb
Type
string
Description
URL para download do arquivo GLB.
Name
fbx
Type
string
Description
URL para download do arquivo FBX.
Name
obj
Type
string
Description
URL para download do arquivo OBJ.
Name
usdz
Type
string
Description
URL para download do arquivo USDZ.
Name
mtl
Type
string
Description
URL para download do arquivo MTL, retornado junto com exportações OBJ quando há texturas.
Name
stl
Type
string
Description
URL para download do arquivo STL.
Name
3mf
Type
string
Description
URL para download do arquivo 3MF. Presente somente quando 3mf foi solicitado por meio de target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL para download da saída GLB original antes de refazer a malha.
Disponível somente quando a tarefa foi criada com should_remesh: true e save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL para download da imagem de miniatura do arquivo de modelo. Equivalente a thumbnail_urls.front quando presente, mantida para compatibilidade retroativa.
Name
alpha_thumbnail_url
Type
string
Description
URL para download de uma versão com fundo transparente (RGBA) de thumbnail_url. Presente somente quando a tarefa foi criada com alpha_thumbnail: true e a pré-visualização transparente foi renderizada com sucesso; caso contrário, este campo é omitido.
Name
thumbnail_urls
Type
object
Description
URLs para download de quatro miniaturas de vistas cardeais do modelo 3D gerado. Cada valor é uma URL assinada para um PNG 512×512 renderizado com os mesmos materiais e iluminação de thumbnail_url. Útil para pré-visualizar o modelo de vários ângulos em pipelines em lote sem baixar o GLB.
Presente somente quando a tarefa foi criada com multi_view_thumbnails: true e atingiu SUCCEEDED. Tarefas mais antigas e tarefas criadas sem a adesão não incluirão este campo.
Name
front
Type
string
Description
Vista frontal, rotação de 0° em torno do eixo vertical (corresponde a thumbnail_url).
Name
right
Type
string
Description
Vista direita, rotação de 90°.
Name
back
Type
string
Description
Vista traseira, rotação de 180°.
Name
left
Type
string
Description
Vista esquerda, rotação de 270°.
Name
texture_prompt
Type
string
Description
O prompt de texto que foi usado para orientar o processo de texturização.
Name
texture_image_url
Type
string
Description
URL para download da imagem de textura que foi usada para orientar o processo de texturização.
Name
progress
Type
integer
Description
Progresso da tarefa. Se a tarefa ainda não foi iniciada, esta propriedade será 0. Quando a tarefa for bem-sucedida, isto se tornará 100.
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.
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 GMT é representada como 1693569600000. Isso se aplica
a todos os carimbos de data/hora na Meshy API.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.
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
status
Type
string
Description
Status da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Um array de objetos de URL de textura gerados a partir da tarefa. Normalmente, isto contém apenas um objeto de URL de textura. Cada URL de textura tem as seguintes propriedades:
Name
base_color
Type
string
Description
URL para download da imagem do mapa de cor base.
Name
metallic
Type
string
Description
URL para download da imagem do mapa metálico.
Se a tarefa for criada com enable_pbr: false, esta propriedade será omitida.
Name
normal
Type
string
Description
URL para download da imagem do mapa de normais.
Se a tarefa for criada com enable_pbr: false, esta propriedade será omitida.
Name
roughness
Type
string
Description
URL para download da imagem do mapa de rugosidade.
Se a tarefa for criada com enable_pbr: false, esta propriedade será omitida.
Name
emission
Type
string
Description
URL para download da imagem do mapa de emissão.
Se a tarefa for criada com enable_pbr: false, ou ai_model for meshy-5, esta propriedade será omitida.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes.
O valor deste campo é significativo somente se o status da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes de erro para tarefas com falha. Consulte 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 (créditos são reembolsados em caso de falha).