A API de Imagem para 3D é uma funcionalidade que permite integrar as capacidades de Imagem para 3D da Meshy na sua própria aplicação. Nesta secção, encontrará toda a informação necessária para começar a utilizar esta API.
Este endpoint permite-lhe criar uma nova tarefa de Imagem para 3D. Consulte
O Objeto de Tarefa Imagem para 3D para ver quais
propriedades estão incluídas no objeto de tarefa Imagem para 3D.
Parâmetros
Apenas um dos parâmetros input_task_id ou image_url é obrigatório. Se ambos forem fornecidos, input_task_id tem prioridade.
Name
input_task_id
Type
string
Obrigatório
Description
O ID de uma tarefa de geração de imagem concluída cujo resultado deve ser utilizado como imagem de entrada. Esta tarefa deve ser uma das seguintes: Texto para imagem ou Imagem para imagem. Além disso, deve ter sido executada através da API, ter o estado SUCCEEDED e produzir exatamente uma imagem.
Name
image_url
Type
string
Obrigatório
Description
Forneça uma imagem para o Meshy utilizar na criação do modelo. Atualmente suportamos os formatos .jpg, .jpeg e .png.
Existem duas formas de fornecer a imagem:
URL publicamente acessível: Um URL que é 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>.
Name
model_type
Type
string
predefinição standard
Description
Especifique o tipo de geração de malha 3D.
Valores disponíveis:
standard: Geração de malha 3D regular de alta definição.
smart-topology: Escolha um modelo Smart Topology com ai_model (meshy-t2).
lowpoly (obsoleto): Gera uma malha low-poly otimizada para polígonos mais limpos. Recomendamos utilizar smart-topology em alternativa.
Quando smart-topology é selecionado, topology, should_remesh e save_pre_remeshed_model são ignorados.
Quando lowpoly é selecionado, ai_model, topology, target_polycount, should_remesh e save_pre_remeshed_model são ignorados.
Name
ai_model
Type
string
predefinição latest
Description
ID do modelo a utilizar. Os valores disponíveis dependem de model_type.
meshy-t2 (predefinição): o modelo Smart Topology — topologia mais limpa, partes nativamente separadas, saída em triângulos e uma contagem de faces que pode definir com target_polycount.
Name
ultra_mode
Type
boolean
predefinição false
Description
Ativa a geração Ultra para uma geometria de maior fidelidade com detalhe de superfície mais fino.
Apenas suportado quando ai_model é meshy-7 (ou latest).
Name
should_texture
Type
boolean
predefinição true
Description
Determina se as texturas são geradas. Definir como false ignora a fase de texturização, fornecendo uma malha sem texturas.
Aplica-se apenas quando should_texture = true
Name
enable_pbr
Type
boolean
predefinição false
Description
Gera 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, exceto em texture_resolution: 8k. meshy-7 e latest não produzem um mapa de emissão.
Name
texture_resolution
Type
string
predefinição 2k
Description
Resolução da textura de cor base. Uma de 2k (2048×2048), 4k (4096×4096), ou 8k (8192×8192). Resoluções mais altas captam mais detalhe de superfície.
4k e 8k não estão disponíveis com ai_model: meshy-5. Em 8k, não é produzido nenhum mapa de emissão.
Name
hd_texture
Type
boolean
⚠ obsoleto
predefinição false
Description
Utilize texture_resolution em alternativa — equivalente a texture_resolution: "4k". Quando ambos são definidos, texture_resolution tem prioridade.
Name
texture_prompt
Type
string
Description
Forneça um prompt de texto para orientar o processo de texturização. Máximo de 800 caracteres.
Name
texture_image_url
Type
string
Description
Forneça uma imagem 2D para orientar o processo de texturização. Atualmente suportamos os formatos .jpg, .jpeg e .png.
Existem duas formas de fornecer a imagem:
URL publicamente acessível: Um URL que é 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>
A texturização por imagem pode não funcionar de forma otimizada se existirem diferenças de geometria substanciais entre o asset original e a imagem carregada. Apenas um dos parâmetros texture_image_url ou texture_prompt pode ser utilizado para orientar o processo de texturização. Se ambos os parâmetros forem fornecidos, então texture_prompt será utilizado para texturizar o modelo por predefinição. A texturização, seja por texto ou por imagem, custará 10 créditos por tarefa.
Controla se a fase de remesh é ativada. Para obter o modelo de maior qualidade, recomendamos definir should_remesh como false.
Aplica-se apenas quando should_remesh = true
Name
topology
Type
string
predefinição triangle
Description
Especifique a topology do modelo gerado.
Valores disponíveis:
quad: Gera uma malha predominantemente em quadriláteros.
triangle: Gera uma malha triangular decimada.
Name
decimation_mode
Type
integer
Description
Ativa a decimação adaptativa definindo um nível de contagem de polígonos. Quando definido, target_polycount é ignorado.
Valores disponíveis:
1: Adaptativa — contagem de polígonos ultra.
2: Adaptativa — contagem de polígonos alta.
3: Adaptativa — contagem de polígonos média.
4: Adaptativa — contagem de polígonos baixa.
Name
save_pre_remeshed_model
Type
boolean
predefinição false
Description
Quando definido como true, o Meshy também guarda um ficheiro GLB adicional antes de a fase de remesh ser concluída.
Name
target_polycount
Type
integer
Description
Número alvo de polígonos (faces) no resultado. A contagem real pode desviar-se do alvo dependendo da geometria.
target_polycount produz efeito em dois casos independentes:
Remesh — com should_remesh: true num modelo standard. A malha é remeshed (decimada) para aproximadamente esta contagem. Intervalo de 100 a 300 000, predefinição 30 000. Se decimation_mode estiver definido, tem prioridade e target_polycount é ignorado.
Smart Topology — com model_type: smart-topology e ai_model: meshy-t2. O modelo é gerado diretamente com esta contagem de faces; não é executado nenhum remesh e should_remesh não é necessário. Intervalo de 100 a 15 000, predefinição 4 000.
Name
symmetry_mode
Type
string
⚠ obsoleto
predefinição auto
Description
Obsoleto. Este parâmetro já não afeta o resultado.
O campo symmetry_mode controla o comportamento de simetria durante o processo de geração do modelo.
Os valores válidos são:
off: Desativa a simetria.
auto: Determina e aplica automaticamente a simetria com base na geometria de entrada.
on: Impõe simetria durante a geração.
Name
pose_mode
Type
string
predefinição ""
Description
Especifique o modo de pose para o modelo gerado.
Valores disponíveis:
a-pose: Gera o modelo numa pose A.
t-pose: Gera o modelo numa pose T.
"" (cadeia vazia): Sem pose específica aplicada.
Name
is_a_t_pose
Type
boolean
⚠ obsoleto
predefinição false
Description
Utilize pose_mode em alternativa. Se deve gerar o modelo numa pose A/T.
Name
image_enhancement
Type
boolean
predefinição true
Description
Otimiza a imagem de entrada para melhores resultados. Defina como false para preservar a aparência exata da imagem de entrada sem qualquer processamento de estilo.
Apenas suportado quando ai_model é meshy-6, meshy-7 ou latest.
Name
remove_lighting
Type
boolean
predefiniçã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.
Apenas suportado quando ai_model é meshy-6.
Name
moderation
Type
boolean
predefinição false
Description
Quando definido como true, o conteúdo de entrada será automaticamente analisado em busca de conteúdo potencialmente prejudicial. Se for detetado conteúdo prejudicial, a tarefa não avançará para a geração.
O conteúdo das entradas image_url, texture_image_url e texture_prompt será analisado.
Name
target_formats
Type
string[]
Description
Especifica quais formatos de ficheiro 3D incluir no resultado. Apenas os formatos solicitados serão gerados e devolvidos, o que pode reduzir o tempo de conclusão da tarefa. Quando omitido, todos os formatos suportados são incluídos.
Quando omitido, são gerados todos os formatos exceto 3mf. O 3mf só é incluído quando explicitamente especificado.
Name
auto_size
Type
boolean
predefinição false
Description
Quando definido como true, o serviço utiliza visão por IA para estimar automaticamente a altura real do objeto e redimensionar o modelo em conformidade. A origem será bottom por predefinição, a menos que origin_at seja explicitamente definido.
Name
alpha_thumbnail
Type
boolean
predefinição false
Description
Quando definido como true, a tarefa renderiza adicionalmente uma versão com fundo transparente (RGBA) da pré-visualização e devolve-a como alpha_thumbnail_url na resposta GET. O campo existente thumbnail_url permanece inalterado.
Name
multi_view_thumbnails
Type
boolean
predefinição false
Description
Quando definido como true, a tarefa renderiza adicionalmente quatro miniaturas de vistas cardinais (frontal, direita, traseira, esquerda) e devolve-as em thumbnail_urls na resposta GET. O campo existente thumbnail_url permanece inalterado e continua a apontar para a vista frontal, pelo que os clientes existentes não são afetados.
Adiciona aproximadamente 3 segundos à latência da tarefa.
Aplica-se apenas quando auto_size = true
Name
origin_at
Type
string
predefinição bottom
Description
Posição da origem quando auto_size está ativado.
Valores disponíveis: bottom, center.
Retorno
A propriedade result da resposta contém o id da tarefa da nova tarefa de Imagem para 3D criada.
Modos de Falha
Name
400 - Bad Request
Description
O pedido foi inaceitável. Causas comuns:
Parâmetro em falta: É necessário fornecer image_url ou input_task_id.
Tarefa de entrada inválida: input_task_id deve referir-se a uma tarefa de Texto para imagem ou Imagem para imagem com estado SUCCEEDED que produza exatamente uma imagem.
Formato de imagem inválido: O image_url fornecido não está num formato suportado (.jpg, .jpeg, .png).
URL inacessível: Não foi possível transferir o image_url (404 ou timeout).
Data URI inválido: A cadeia base64 está malformada.
Combinação de parâmetros inválida: enable_pbr apenas é suportado quando should_texture é verdadeiro.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique a sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
429 - Too Many Requests
Description
Excedeu o seu limite de taxa.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-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>" }'# With remesh, PBR, and A-posecurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-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>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Este endpoint permite-lhe recuperar uma tarefa de Imagem para 3D dado 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 para a tarefa de Imagem para 3D a recuperar.
O objeto 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 para a tarefa. Embora utilizemos um UUID k-sortable para ids de tarefas como detalhe de implementação, não deve fazer quaisquer suposições sobre o formato do id.
Name
type
Type
string
Description
Tipo da tarefa de Imagem para 3D. O valor é image-to-3d.
Name
model_urls
Type
object
Description
URL para download do ficheiro do modelo 3D texturizado gerado pela Meshy. A propriedade para 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 ficheiro GLB.
Name
fbx
Type
string
Description
URL para download do ficheiro FBX.
Name
obj
Type
string
Description
URL para download do ficheiro OBJ.
Name
usdz
Type
string
Description
URL para download do ficheiro USDZ.
Name
mtl
Type
string
Description
URL para download do ficheiro MTL, retornado juntamente com exportações OBJ quando texturas estão presentes.
Name
stl
Type
string
Description
URL para download do ficheiro STL.
Name
3mf
Type
string
Description
URL para download do ficheiro 3MF. Apenas presente quando 3mf foi solicitado via target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL para download da saída GLB original antes do remesh.
Disponível apenas quando a tarefa foi criada com ambos should_remesh: true e save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL para download da imagem de miniatura do ficheiro do modelo. Equivalente a thumbnail_urls.front quando presente, mantido para compatibilidade retroativa.
Name
alpha_thumbnail_url
Type
string
Description
URL para download de uma versão com fundo transparente (RGBA) de thumbnail_url. Apenas presente 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 miniaturas de visualização cardinal do modelo 3D gerado. Cada valor é um URL assinado para um PNG 512×512 renderizado com os mesmos materiais e iluminação que thumbnail_url. Útil para pré-visualizar o modelo de múltiplos ângulos em pipelines em lote sem descarregar o GLB.
Apenas presente quando a tarefa foi criada com multi_view_thumbnails: true e alcançou SUCCEEDED. Tarefas mais antigas e tarefas criadas sem a opçã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 guiar o processo de texturização.
Name
texture_image_url
Type
string
Description
URL para download da imagem de textura que foi usada para guiar o processo de texturização.
Name
ultra_mode
Type
boolean
Description
Reflete o valor ultra_mode com o qual a tarefa foi criada. Apenas presente para tarefas meshy-7 (ou latest) que definiram explicitamente ultra_mode; omitido caso contrário.
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, 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 PM GMT é representado como 1693569600000. Isto aplica-se 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
Estado 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 URL de textura que são gerados a partir da tarefa. Normalmente, isto contém apenas um objeto 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, meshy-7, ou latest, esta propriedade será omitida.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes.
O valor deste campo é significativo apenas se o estado 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 estado da tarefa é PENDING, IN_PROGRESS, ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).