A API de Texto para 3D é um recurso que permite integrar as capacidades de Texto para 3D do Meshy em seu próprio aplicativo. Nesta seção, você encontrará todas as informações necessárias para começar a usar esta API.
Texto para 3D usa um fluxo de trabalho em duas etapas. Primeiro, crie uma tarefa de pré-visualização (mode: "preview") para gerar uma malha 3D sem textura, para que você possa avaliar a forma. Depois, passe o ID da tarefa de pré-visualização concluída para uma tarefa de refinamento (mode: "refine") para aplicar textura à malha. Ambas as etapas compartilham o mesmo endpoint.
Este endpoint cria uma tarefa de pré-visualização de Texto para 3D, que gera uma malha 3D não texturizada (apenas geometria) a partir de um prompt de texto. Este é o primeiro passo do fluxo de trabalho em duas etapas. Assim que a pré-visualização for bem-sucedida, use o ID da tarefa retornada para criar uma tarefa de refinamento para texturização. Consulte O Objeto Tarefa de Texto para 3D para o esquema completo da resposta.
Parâmetros
Name
mode
Type
string
Obrigatório
Description
Este campo deve ser configurado como "preview" ao criar uma tarefa de pré-visualização.
Name
prompt
Type
string
Obrigatório
Description
Descreva que tipo de objeto o modelo 3D é. Máximo de 600 caracteres.
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 de alta precisão regular.
lowpoly: Gera malha low-poly otimizada para polígonos mais limpos.
Quando lowpoly é selecionado, ai_model, topology, target_polycount, should_remesh 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_remesh
Type
boolean
padrão false (meshy-6), true (others)
Description
Controla se a fase de remesh deve ser ativada. Para o modelo de mais alta qualidade, recomendamos configurar should_remesh para false.
Aplica-se somente quando should_remesh = true
Name
topology
Type
string
padrão triangle
Description
Especifique a topologia do modelo gerado.
Valores disponíveis:
quad: Gera uma malha dominante quadrada.
triangle: Gera uma malha de triângulos 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 desviar do alvo dependendo da complexidade da geometria.
O intervalo de valores válidos varia dependendo do nível do usuário:
100 a 300.000 (inclusive)
Name
decimation_mode
Type
integer
Description
Ative a decimação adaptativa configurando um nível de contagem de polígonos. Quando configurado, target_polycount é ignorado.
Valores disponíveis:
1: Adaptativo — contagem ultra de polígonos.
2: Adaptativo — alta contagem de polígonos.
3: Adaptativo — contagem média de polígonos.
4: Adaptativo — baixa contagem de polígonos.
Name
symmetry_mode
Type
string
⚠ obsoleto
padrão auto
Description
Obsoleto. 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: Desativa a simetria.
auto: Determina e aplica automaticamente a simetria com base na geometria de entrada.
Use pose_mode em vez disso. Se deve gerar o modelo em uma pose A/T.
Name
art_style
Type
string
⚠ obsoleto
padrão realistic
Description
Não suportado pelo Meshy-6. Solicitações usando Meshy 6 ignorarão art_style, e algumas combinações podem causar erros. Valores disponíveis: realistic, sculpture.
enable_pbr deve ser definido como false ao usar o estilo Sculpture, pois o estilo Sculpture gera seu próprio conjunto de mapas PBR.
Name
moderation
Type
boolean
padrão false
Description
Quando configurado como true, o conteúdo de entrada será automaticamente filtrado para detectar potencialmente conteúdo nocivo. Se conteúdo nocivo for detectado, a tarefa não prosseguirá para a geração.
O texto do prompt será filtrado.
Name
target_formats
Type
string[]
Description
Especifica quais formatos de arquivo 3D incluir na saída. Apenas os formatos solicitados serão gerados e retornados, o que pode reduzir o tempo de conclusão da tarefa. Quando omitido, todos os formatos suportados são incluídos.
Quando omitidos, todos os formatos, exceto 3mf, são gerados. 3mf só é incluído quando especificado explicitamente.
Name
alpha_thumbnail
Type
boolean
padrão false
Description
Quando configurada 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
auto_size
Type
boolean
padrão false
Description
Quando configurada como true, o serviço usa visão AI para estimar automaticamente a altura real do objeto e redimensiona o modelo de acordo. A origem será padrão para bottom a menos que origin_at seja configurado explicitamente.
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.
Retornos
A propriedade result da resposta contém o id da tarefa recém-criada de Texto para 3D.
Modos de Falha
Name
400 - Bad Request
Description
A solicitação foi inaceitável. Causas comuns:
Parâmetro ausente: Um parâmetro obrigatório (por exemplo, prompt, mode) está ausente.
Parâmetro inválido: art_style não é um dos valores permitidos.
Prompt muito longo: O prompt excede o limite de caracteres.
Name
401 - Unauthorized
Description
A autenticação falhou. 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.
Request
POST
/openapi/v2/text-to-3d
# Pré-visualização simples com apenas os parâmetros necessárioscurlhttps://api.meshy.ai/openapi/v2/text-to-3d \-H'Authorization: Bearer ${YOUR_API_KEY}' \-H'Content-Type: application/json' \-d'{ "mode": "preview", "prompt": "uma máscara de monstro"}'# Pré-visualização com remesh e pose Acurlhttps://api.meshy.ai/openapi/v2/text-to-3d \-H'Authorization: Bearer ${YOUR_API_KEY}' \-H'Content-Type: application/json' \-d'{ "mode": "preview", "prompt": "um guerreiro robô futurista", "should_remesh": true, "target_polycount": 100000, "pose_mode": "a-pose", "target_formats": ["glb"]}'
Este endpoint cria uma tarefa de refinamento de Texto para 3D, que aplica textura a uma malha de pré-visualização concluída. Você deve fornecer o preview_task_id de uma tarefa de pré-visualização bem-sucedida. Este é o segundo passo do fluxo de trabalho em duas etapas.
Parâmetros
Name
mode
Type
string
Obrigatório
Description
Este campo deve ser configurado como "refine" ao criar uma tarefa de refinamento.
Name
preview_task_id
Type
string
Obrigatório
Description
O ID da tarefa de pré-visualização correspondente.
O status da tarefa de pré-visualização fornecida deve ser SUCCEEDED.
Name
enable_pbr
Type
boolean
padrão false
Description
Gera mapas PBR (metálico, rugosidade, normais) além da cor base. Um mapa de emissão também é incluído quando ai_model é meshy-6 ou latest, exceto em texture_resolution: 8k (nenhum mapa de emissão é produzido).
Name
texture_resolution
Type
string
padrão 2k
Description
Resolução da textura de cor base. Um de 2k (2048×2048), 4k (4096×4096) ou 8k (8192×8192). Resoluções mais altas capturam mais detalhes de superfície. Só se aplica ao modo refine.
4k e 8k requerem ai_modelmeshy-6 ou latest. Em 8k, nenhum mapa de emissão é produzido.
Name
hd_texture
Type
boolean
⚠ obsoleto
padrão false
Description
Use texture_resolution em vez disso — equivale a texture_resolution: "4k". Quando ambos são definidos, texture_resolution tem precedência.
Name
texture_prompt
Type
string
Description
Forneça um prompt de texto adicional para guiar o processo de texturização. Máximo de 600 caracteres.
Name
texture_image_url
Type
string
Description
Forneça uma imagem 2D para guiar o processo de texturização. Atualmente, suportamos os formatos .jpg, .jpeg e .png.
Existem duas maneiras de fornecer a imagem:
URL acessível publicamente: Um URL que é acessível na 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>
A texturização de imagem pode não funcionar de forma ideal se houver diferenças substanciais de geometria entre o asset original e a imagem carregada. Apenas um de texture_image_url ou texture_prompt pode ser usado para guiar 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.
Name
ai_model
Type
string
padrão latest
Description
ID do modelo a ser usado para refinamento. Valores disponíveis: meshy-5, meshy-6, latest (Meshy 6).
Name
moderation
Type
boolean
padrão false
Description
Quando configurado como true, o conteúdo de entrada será automaticamente filtrado para detectar potencialmente conteúdo nocivo. Se conteúdo nocivo for detectado, a tarefa não prosseguirá para a geração.
Tanto o texto de texture_prompt quanto a imagem de texture_image_url serão filtrados.
Name
remove_lighting
Type
boolean
padrão true
Description
Remove os destaques e sombras da textura de cor base, produzindo um resultado mais limpo que funciona melhor em configurações de iluminação personalizadas.
Só é suportado quando ai_model é meshy-6 ou latest.
Name
target_formats
Type
string[]
Description
Especifica quais formatos de arquivo 3D incluir na saída. Apenas os formatos solicitados serão gerados e retornados, o que pode reduzir o tempo de conclusão da tarefa. Quando omitido, todos os formatos suportados são incluídos.
Quando omitidos, todos os formatos, exceto 3mf, são gerados. 3mf só é incluído quando especificado explicitamente.
Name
alpha_thumbnail
Type
boolean
padrão false
Description
Quando configurada 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
auto_size
Type
boolean
padrão false
Description
Quando configurada como true, o serviço usa visão AI para estimar automaticamente a altura real do objeto e redimensiona o modelo de acordo. A origem será padrão para bottom a menos que origin_at seja configurado explicitamente.
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.
Retornos
A propriedade result da resposta contém o id da tarefa recém-criada de Texto para 3D.
Modos de Falha
Name
400 - Bad Request
Description
A solicitação foi inaceitável. Causas comuns:
ID da tarefa inválido: O preview_task_id é inválido ou não existe.
Tarefa não está pronta: A tarefa de pré-visualização ainda não foi bem-sucedida.
Incompatibilidade de modelo: O AI model da tarefa de pré-visualização é incompatível com o modelo de refinamento solicitado.
Name
401 - Unauthorized
Description
A autenticação falhou. 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 pré-visualização especificada por preview_task_id não foi encontrada.
Este endpoint permite que você recupere uma tarefa de Texto para 3D dado um ID de tarefa válido.
Consulte O Objeto Tarefa de Texto para 3D para ver quais
propriedades estão incluídas no objeto de tarefa de Texto para 3D.
Este endpoint funciona tanto para tarefas de pré-visualização quanto de refinamento.
Parâmetros
Name
id
Type
path
Description
Identificador único para a tarefa de Texto para 3D a ser recuperada.
// Exemplo de evento de erroevent: errordata: {"status_code": 404,"message": "Tarefa não encontrada"}// Exemplos de evento de mensagem ilustram o progresso da tarefa.// Para tarefas PENDING ou IN_PROGRESS, o fluxo de resposta não incluirá todos os campos.event: messagedata: {"id": "018a210d-8ba4-705c-b111-1f1776f7f578","progress": 0,"status": "PENDING"}event: messagedata: {"id": "018a210d-8ba4-705c-b111-1f1776f7f578","progress": 50,"status": "IN_PROGRESS"}event: messagedata: {"id": "018a210d-8ba4-705c-b111-1f1776f7f578","type": "text-to-3d-preview","progress": 100,"status": "SUCCEEDED","created_at": 1692771650657,"started_at": 1692771667037,"finished_at": 1692771669037,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"},"texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***","metallic":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX","normal":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX","roughness":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX","emission":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX" }],"preceding_tasks": 0,"task_error": {"message":""},"consumed_credits": 20}
O Objeto Tarefa de Texto para 3D é uma unidade de trabalho que o Meshy acompanha para gerar um modelo 3D a partir de uma entrada de texto. Existem dois estágios da API de Texto para 3D, preview e refine. O estágio de pré-visualização é para gerar um modelo 3D apenas de malha, e o estágio de refinamento é para gerar um modelo 3D texturizado com base no resultado do estágio de pré-visualização.
O objeto possui as seguintes propriedades:
Propriedades
Name
id
Type
string
Description
Identificador único para a tarefa. Enquanto usamos um UUID k-sortable para IDs de tarefa como o
detalhe de implementação, você não deve fazer suposições sobre o formato do ID.
Name
type
Type
string
Description
Tipo da tarefa de Texto para 3D. Valores possíveis são text-to-3d-preview para tarefas de estágio de pré-visualização e text-to-3d-refine para tarefas de estágio de refinamento.
Name
model_urls
Type
object
Description
URL para download do arquivo de modelo 3D texturizado gerado pelo 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 arquivo GLB.
Name
fbx
Type
string
Description
URL para download do arquivo FBX.
Name
usdz
Type
string
Description
URL para download do arquivo USDZ.
Name
obj
Type
string
Description
URL para download do arquivo OBJ.
Name
mtl
Type
string
Description
URL para download do arquivo MTL.
Name
stl
Type
string
Description
URL para download do arquivo STL.
Name
3mf
Type
string
Description
URL para download do arquivo 3MF. Apenas presente quando 3mf foi solicitado via target_formats.
Name
prompt
Type
string
Description
Este é o prompt não modificado que foi usado para criar a tarefa.
Name
negative_prompt
Type
string
⚠ obsoleto
Description
Mantido para compatibilidade retroativa. Este campo não tem impacto funcional nos modelos gerados.
Name
art_style
Type
string
⚠ obsoleto
Description
O art_style não modificado que foi usado para criar a tarefa de pré-visualização. Não é suportado pelo Meshy-6.
Name
texture_richness
Type
string
⚠ obsoleto
Description
Mantido para compatibilidade retroativa. Este campo não tem impacto funcional nos modelos gerados.
Name
texture_prompt
Type
string
Description
Prompt de texto adicional fornecido para guiar o processo de texturização durante a etapa de refinamento.
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
thumbnail_url
Type
string
Description
URL para download da imagem em miniatura do arquivo de modelo.
Name
alpha_thumbnail_url
Type
string
Description
URL para download de uma versão com fundo transparente (RGBA) de thumbnail_url. Presente apenas 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
video_url
Type
string
⚠ obsoleto
Description
URL para download do vídeo de pré-visualização. Será removido em uma versão futura.
Name
progress
Type
integer
Description
Progresso da tarefa. Se a tarefa ainda não foi iniciada, essa propriedade será 0. Uma vez que a tarefa tenha sido bem-sucedida, isso 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, essa 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. 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
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 finalizada, essa propriedade será 0.
Name
status
Type
string
Description
Status da tarefa. Valores possíveis são um dos 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, isso 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 de mapa de cor base.
Name
metallic
Type
string
Description
URL para download da imagem de mapa metálico.
Se a tarefa for criada com enable_pbr: false, essa propriedade será omitida.
Name
normal
Type
string
Description
URL para download da imagem de mapa de normais.
Se a tarefa for criada com enable_pbr: false, essa propriedade será omitida.
Name
roughness
Type
string
Description
URL para download da imagem de mapa de rugosidade.
Se a tarefa for criada com enable_pbr: false, essa propriedade será omitida.
Name
emission
Type
string
Description
URL para download da imagem de mapa de emissão.
Se a tarefa for criada com enable_pbr: false, ou ai_model for meshy-5, essa propriedade será omitida.
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).
Example Text to 3D Task Object
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"text-to-3d-preview","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***","fbx":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***","stl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***" },"prompt":"uma máscara de monstro","texture_prompt":"pele viscosa verde com escamas e verrugas","texture_image_url":"","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"started_at":1692771667037,"created_at":1692771650657,"finished_at":1692771669037,"status":"SUCCEEDED","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***","metallic":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX","normal":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX","roughness":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX","emission":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX" } ],"preceding_tasks":0,"task_error": {"message":"" },"consumed_credits":20}