A API de Texto para 3D é um recurso que permite integrar as capacidades de Texto para 3D da Meshy à sua própria aplicação. Nesta seção, você encontrará todas as informações
necessárias para começar a usar essa API.
Texto para 3D utiliza um fluxo de trabalho de duas etapas. Primeiro, crie uma tarefa de preview (mode: "preview") para gerar uma malha 3D sem textura, para que você possa avaliar a forma. Em seguida, passe o ID da tarefa do preview concluído para uma tarefa de refine (mode: "refine") para aplicar textura à malha. Ambas as etapas compartilham o mesmo endpoint.
Este endpoint cria uma tarefa de preview de Texto para 3D, que gera uma malha 3D sem textura (apenas geometria) a partir de um prompt de texto. Esta é a primeira etapa do fluxo de trabalho de duas etapas. Após o sucesso do preview, use o ID da tarefa retornado para criar uma tarefa refine para aplicar texturas. Consulte
O objeto de tarefa Texto para 3D para o esquema completo da resposta.
Parâmetros
Name
mode
Type
string
Obrigatório
Description
Este campo deve ser definido como "preview" ao criar uma tarefa de preview.
Name
prompt
Type
string
Obrigatório
Description
Descreva que tipo de objeto o modelo 3D representa. Máximo de 800 caracteres.
Name
model_type
Type
string
padrão standard
Description
Especifica o tipo de geração de malha 3D.
Valores disponíveis:
standard: Geração de malha 3D regular de alto detalhe.
smart-topology: Escolha o modelo Smart Topology com ai_model (meshy-t2).
lowpoly (obsoleto): Gera malha low-poly otimizada para polígonos mais limpos. Recomendamos usar smart-topology em vez disso.
Quando smart-topology é selecionado, should_remesh e decimation_mode são ignorados, e apenas topology: triangle é aceito.
Quando lowpoly é selecionado, ai_model, topology, target_polycount e should_remesh são ignorados.
Name
ai_model
Type
string
padrão latest
Description
ID do modelo a ser usado. Os valores disponíveis dependem de model_type.
meshy-t2 (padrão): o modelo Smart Topology — topology mais limpa, partes nativamente separadas, saída em triângulos e uma contagem de faces que você pode definir com target_polycount.
Name
geometry_resolution
Type
string
padrão standard
Description
Passagem de geração de geometria. 2k executa a passagem Ultra em 2048³; 4k a executa em 4096³ para o
detalhe de superfície mais refinado.
Valores disponíveis: standard, 2k, 4k
Suportado apenas no mode preview. Requer meshy-7.1 ou latest.
Name
ultra_mode
Type
boolean
⚠ obsoleto
padrão false
Description
Use geometry_resolution em vez disso. ultra_mode: true é equivalente a geometry_resolution: "2k".
Name
should_remesh
Type
boolean
padrão false (Meshy 6 and Meshy 7 models), true (others)
Description
Controla se a fase de remesh deve ser ativada. Para o modelo de mais alta qualidade, recomendamos definir should_remesh como false.
Aplica-se somente quando should_remesh = true
Name
topology
Type
string
padrão triangle
Description
Especifica a topology do modelo gerado.
Valores disponíveis:
quad: Gera uma malha predominantemente quad.
triangle: Gera uma malha triangular decimada.
A saída do Smart Topology é exclusivamente triangular. Solicitar quad junto com ai_model: meshy-t2 retorna um erro.
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: 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
target_polycount
Type
integer
Description
Número desejado de polígonos (faces) na saída. A contagem real pode divergir do valor desejado dependendo da geometria.
target_polycount tem efeito em dois casos independentes:
Remesh — com should_remesh: true em um modelo standard. A malha é remeshada (decimada) para aproximadamente essa contagem. Intervalo de 100 a 300.000, padrão 30.000. Se decimation_mode estiver definido, ele tem prioridade e target_polycount é ignorado.
Smart Topology — com model_type: smart-topology e ai_model: meshy-t2. O modelo é gerado diretamente com essa contagem de faces; nenhum remesh é executado e should_remesh não é necessário. Intervalo de 100 a 15.000, padrão 4.000.
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. Define se o modelo deve ser gerado 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 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 avançará para a geração.
O texto de prompt será verificado.
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 omitido, todos os formatos exceto 3mf são gerados. 3mf só é incluído quando explicitamente especificado.
Name
alpha_thumbnail
Type
boolean
padrão false
Description
Quando definido como true, a tarefa também renderiza uma versão com fundo transparente (RGBA) do preview e a retorna como alpha_thumbnail_url na resposta do GET. O campo thumbnail_url existente permanece inalterado.
Name
auto_size
Type
boolean
padrão false
Description
Quando definido como true, o serviço usa visão de IA para estimar automaticamente a altura real do objeto e redimensionar o modelo de acordo. A origem será bottom por padrão, a menos que origin_at seja explicitamente definido.
Aplica-se somente quando auto_size = true
Name
origin_at
Type
string
padrão bottom
Description
Posição da origem quando auto_size está ativado.
Valores disponíveis: bottom, center.
Retornos
A propriedade result da resposta contém o id da tarefa da nova tarefa de Texto para 3D criada.
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.
Modelo não suportado para low poly: ai_model: "meshy-6-lite" não suporta model_type: "lowpoly".
Modelo não suportado para Ultra: geometry_resolution requer meshy-7.1 ou latest.
Name
401 - Unauthorized
Description
Falha na autenticação. Verifique sua chave de API.
Este endpoint cria uma tarefa de refine do Texto para 3D, que aplica textura a uma malha de preview concluída. Você deve fornecer o preview_task_id de uma tarefa de preview bem-sucedida. Esta é a segunda etapa do fluxo de trabalho de duas etapas.
Parâmetros
Name
mode
Type
string
Obrigatório
Description
Este campo deve ser definido como "refine" ao criar uma tarefa de refine.
Name
preview_task_id
Type
string
Obrigatório
Description
O id da tarefa de preview correspondente.
O status da tarefa de preview informada deve ser SUCCEEDED.
Name
enable_pbr
Type
boolean
padrão false
Description
Gera mapas PBR (metallic, roughness, 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 (nenhum mapa de emissão é produzido). meshy-6-lite, meshy-7.1 e latest não produzem mapa de emissão.
Name
texture_resolution
Type
string
padrão 2k
Description
Resolução da textura de cor base. Uma entre 2k (2048×2048), 4k (4096×4096) ou 8k (8192×8192). Resoluções mais altas capturam mais detalhes de superfície. Aplica-se apenas ao mode refine.
4k e 8k exigem ai_modelmeshy-6, meshy-7.1 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 — equivalente 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 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. No momento, oferecemos suporte aos formatos .jpg, .jpeg e .png.
Há duas maneiras de fornecer a imagem:
URL publicamente acessível: uma URL que pode ser acessada pela 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 ideal se houver diferenças substanciais de geometria entre o asset original e a imagem enviada. Apenas um dos parâmetros texture_image_url ou texture_prompt pode ser usado para orientar o processo de texturização. Se ambos forem fornecidos, texture_prompt será usado por padrão para texturizar o modelo.
Omita este parâmetro para herdar o modelo usado pela tarefa de preview, o que mantém um preview e seu refine no mesmo modelo do início ao fim. Passe um valor explícito para substituir essa herança.
Um valor explícito latest é resolvido aqui exatamente como na tarefa de preview (atualmente Meshy 7.1), de modo que um preview latest e seu refine latest sempre recaem no mesmo modelo de textura.
Name
moderation
Type
boolean
padrão false
Description
Quando definido como true, o conteúdo de entrada será automaticamente verificado em busca de conteúdo potencialmente prejudicial. Se conteúdo prejudicial 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 verificados.
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.
Só tem efeito quando ai_model é meshy-6; outros modelos o ignoram.
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 suportados são incluídos.
Quando omitido, todos os formatos exceto 3mf são gerados. 3mf só é incluído quando explicitamente especificado.
Name
alpha_thumbnail
Type
boolean
padrão false
Description
Quando definido como true, a tarefa renderiza adicionalmente uma versão com fundo transparente (RGBA) do preview 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 definido como true, o serviço usa visão de IA para estimar automaticamente a altura real do objeto e redimensionar o modelo de acordo. A origem será bottom por padrão, a menos que origin_at seja explicitamente definido.
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 do Texto para 3D.
Modos de falha
Name
400 - Bad Request
Description
A solicitação foi inaceitável. Causas comuns:
ID de tarefa inválido: o preview_task_id é inválido ou não existe.
Tarefa não pronta: a tarefa de preview ainda não foi concluída com sucesso.
Incompatibilidade de modelo: o modelo de IA da tarefa de preview é incompatível com o modelo de refine solicitado.
Name
401 - Unauthorized
Description
Falha na autenticação. 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 preview especificada por preview_task_id não foi encontrada.
Este endpoint permite recuperar uma tarefa de Texto para 3D a partir de um id de tarefa válido.
Consulte O Objeto de 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 preview quanto de refine.
Parâmetros
Name
id
Type
path
Description
Identificador único da tarefa de Texto para 3D a ser recuperada.
Este endpoint exclui permanentemente uma tarefa de Texto para 3D, incluindo todos os modelos e dados associados. Esta ação é irreversível.
Parâmetros de Caminho
Name
id
Type
path
Description
O ID da tarefa de Texto para 3D a ser excluída.
Status da Tarefa
Uma tarefa que ainda está PENDING é excluída e os créditos consumidos no
momento da criação são reembolsados.
Uma tarefa que já está IN_PROGRESS não pode ser excluída: a solicitação é
rejeitada com 409 Conflict e a tarefa continua em execução. Os créditos de uma tarefa
que o worker já começou a processar não são reembolsáveis, então excluí-la no meio da execução
custaria tanto os créditos quanto o resultado. Aguarde até que ela alcance
SUCCEEDED, FAILED ou CANCELED, e então a exclua.
Uma tarefa em um estado terminal (SUCCEEDED, FAILED ou CANCELED) é excluída
sem reembolso.
Retornos
Retorna 200 OK em caso de sucesso, ou 409 Conflict quando a tarefa está
IN_PROGRESS.
// 200 OK on success, with an empty body.//// 409 Conflict when the task is IN_PROGRESS — the task is left running:{"message":"Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."}
O objeto Text to 3D Task é uma unidade de trabalho que a Meshy mantém para gerar um modelo 3D a partir de uma entrada de texto. Existem dois estágios da Text to 3D API, preview e refine. O estágio preview serve para gerar um modelo 3D apenas com malha, e o estágio refine serve para gerar um modelo 3D texturizado com base no resultado do estágio preview.
O objeto possui as seguintes propriedades:
Properties
Name
id
Type
string
Description
Identificador único da tarefa. Embora usemos um UUID k-sortable 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 Text to 3D. Os valores possíveis são text-to-3d-preview para tarefas do estágio preview e text-to-3d-refine para tarefas do estágio refine.
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
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. Presente apenas 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 preview. 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 o estágio refine.
Name
ultra_mode
Type
boolean
⚠ obsoleto
Description
Obsoleto; consulte geometry_resolution em vez disso.
Name
geometry_resolution
Type
string
Description
O nível Ultra em que a tarefa de preview foi executada (2k ou 4k); omitido para standard.
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 de miniatura do arquivo do 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, esta propriedade será 0. Uma vez que a tarefa tenha sido concluída com sucesso, ela 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 transcorridos 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 finalizada, em milissegundos. Se a tarefa ainda não foi finalizada, esta propriedade será 0.
Name
status
Type
string
Description
Status da tarefa. Os valores possíveis são um dos seguintes: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Um array de objetos de URL de textura que são gerados a partir da tarefa. Normalmente, isso contém apenas um objeto de URL de textura. Cada URL de textura possui 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-6-lite, esta propriedade será omitida.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes.
O valor deste campo só é significativo 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 (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":"a monster mask","texture_prompt":"green slimy skin with scales and warts","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}