A API de Texto para 3D é uma funcionalidade que lhe permite integrar as capacidades de Texto para 3D da Meshy na sua própria aplicação. Nesta secção, encontrará todas as informações
de que precisa para começar a utilizar esta API.
Texto para 3D utiliza um fluxo de trabalho em dois passos. Primeiro, crie uma tarefa de pré-visualização (mode: "preview") para gerar uma malha 3D sem textura, para que 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. Ambos os passos partilham o mesmo endpoint.
Este endpoint cria uma tarefa de pré-visualização de Texto para 3D, que gera uma malha 3D sem texturização (apenas geometria) a partir de um prompt de texto. Este é o primeiro passo do fluxo de trabalho em dois passos. Depois de a pré-visualização ser concluída com sucesso, utilize o ID da tarefa devolvido para criar uma tarefa de refinamento para texturização. Consulte
O objeto de tarefa de Texto para 3D para o esquema de resposta completo.
Parâmetros
Name
mode
Type
string
Obrigatório
Description
Este campo deve ser definido 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
predefinição standard
Description
Especifique o tipo de Geração de malha 3D.
Valores disponíveis:
standard: Geração de malha 3D normal de elevado detalhe.
lowpoly: Gera uma 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
predefinição latest
Description
ID do modelo a utilizar. Valores disponíveis: meshy-5, meshy-6, latest (Meshy 6).
Name
should_remesh
Type
boolean
predefinição false (meshy-6), true (others)
Description
Controla se a fase de Remesh é ativada. Quando definido como false, a API devolve diretamente a malha triangular de maior precisão.
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 quadrilateral.
triangle: Gera uma malha triangular decimada.
Name
target_polycount
Type
integer
predefinição 30,000
Description
Especifique o número-alvo de polígonos no modelo gerado. O número real de polígonos pode desviar-se do alvo, dependendo da complexidade da geometria.
O intervalo de valores válido varia consoante o nível do utilizador:
100 a 300.000 (inclusive)
Name
decimation_mode
Type
integer
Description
Ative 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 elevada.
3: Adaptativo — contagem de polígonos média.
4: Adaptativo — contagem de polígonos baixa.
Name
symmetry_mode
Type
string
⚠ obsoleto
predefinição auto
Description
Obsoleto (deprecated). 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.
Utilize pose_mode em vez disso. Se deve gerar o modelo numa pose A/T.
Name
art_style
Type
string
⚠ obsoleto
predefinição realistic
Description
Não suportado pelo Meshy-6. Os pedidos que utilizem Meshy-6 irão ignorar art_style, e algumas combinações podem causar erros. Valores disponíveis: realistic, sculpture.
enable_pbr deve ser definido como false ao utilizar o estilo Sculpture, uma vez que o estilo Sculpture gera o seu próprio conjunto de mapas PBR.
Name
moderation
Type
boolean
predefinição false
Description
Quando definido como true, o conteúdo de entrada será automaticamente analisado quanto a conteúdo potencialmente prejudicial. Se for detetado conteúdo prejudicial, a tarefa não prosseguirá para a geração.
O texto de prompt será analisado.
Name
target_formats
Type
string[]
Description
Especifica quais os formatos de ficheiro 3D a 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, todos os formatos exceto 3mf são gerados. 3mf só é incluído quando explicitamente especificado.
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 thumbnail_url existente permanece inalterado.
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á predefinida como bottom, exceto se origin_at for definido explicitamente.
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.
Devoluções
A propriedade result da resposta contém o id da tarefa de Texto para 3D recém-criada.
Modos de falha
Name
400 - Bad Request
Description
O pedido não era aceitável. Causas comuns:
Parâmetro em falta: Um parâmetro obrigatório (por exemplo, prompt, mode) está em falta.
Parâmetro inválido: art_style não é um dos valores permitidos.
Prompt demasiado longo: O prompt excede o limite de caracteres.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique a sua chave de API.
Este endpoint cria uma tarefa de refinamento de Texto para 3D, que aplica textura a uma malha de pré-visualização concluída. Deve fornecer o preview_task_id de uma tarefa de pré-visualização bem-sucedida. Este é o segundo passo do fluxo de trabalho em dois passos.
Parâmetros
Name
mode
Type
string
Obrigatório
Description
Este campo deve ser definido 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 estado da tarefa de pré-visualização fornecida deve ser SUCCEEDED.
Name
enable_pbr
Type
boolean
predefinição false
Description
Gera mapas PBR (metálico, rugosidade, normal) além da cor base. Também é incluído um mapa de emissão quando ai_model é meshy-6 ou latest.
Name
hd_texture
Type
boolean
predefinição false
Description
Gera a textura de cor base em resolução 4K (4096×4096) para maior detalhe.
Suportado 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 adicional 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, suportamos os formatos .jpg, .jpeg e .png.
Existem duas formas de fornecer a imagem:
URL acessível publicamente: Um URL que está acessível a partir da Internet pública
Data URI: Um Data URI codificado em base64 da imagem. 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 existirem diferenças substanciais de geometria entre o asset original e a imagem carregada. Apenas um de 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 por predefinição para texturizar o modelo.
Name
ai_model
Type
string
predefinição latest
Description
ID do modelo a utilizar para refinar. Valores disponíveis: meshy-5, meshy-6, latest (Meshy 6).
Name
moderation
Type
boolean
predefinição false
Description
Quando definido como true, o conteúdo de entrada será automaticamente analisado para detetar conteúdo potencialmente prejudicial. Se for detetado conteúdo prejudicial, a tarefa não avançará para a geração.
Tanto o texto de texture_prompt como a imagem de texture_image_url serão analisados.
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.
Suportado apenas quando ai_model é meshy-6 ou latest.
Name
target_formats
Type
string[]
Description
Especifica quais os formatos de ficheiro 3D a incluir na saída. 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, todos os formatos exceto 3mf são gerados. 3mf só é incluído quando especificado explicitamente.
Name
alpha_thumbnail
Type
boolean
predefinição false
Description
Quando definido como true, a tarefa renderiza adicionalmente uma versão da pré-visualização com fundo transparente (RGBA) e devolve-a como alpha_thumbnail_url na resposta GET. O campo thumbnail_url existente permanece inalterado.
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á predefinida como bottom, a menos que origin_at seja definido explicitamente.
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.
Valores devolvidos
A propriedade result da resposta contém o id da tarefa de Texto para 3D recém-criada.
Modos de falha
Name
400 - Bad Request
Description
O pedido era 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 pré-visualização ainda não foi bem-sucedida.
Incompatibilidade de modelo: O modelo de IA da tarefa de pré-visualização é incompatível com o modelo de refinamento solicitado.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique a sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para executar 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-lhe obter uma tarefa de Texto para 3D dado um id de tarefa válido.
Consulte O Objeto de Tarefa de Texto para 3D para ver que
propriedades estão incluídas no objeto de tarefa de Texto para 3D.
Este endpoint funciona tanto para tarefas de pré-visualização como de refinamento.
Parâmetros
Name
id
Type
path
Description
Identificador único da tarefa de Texto para 3D a obter.
O objeto de Tarefa de Texto para 3D é uma unidade de trabalho que a Meshy acompanha para gerar um modelo 3D a partir de uma entrada de texto. Existem duas fases da API de Texto para 3D, preview e refine. A fase de pré-visualização serve para gerar um modelo 3D apenas com malha, e a fase de refinamento serve para gerar um modelo 3D com texturas com base no resultado da fase de pré-visualização.
O objeto tem as seguintes propriedades:
Propriedades
Name
id
Type
string
Description
Identificador único da tarefa. Embora usemos um UUID ordenável por k para os ids das 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 Texto para 3D. Os valores possíveis são text-to-3d-preview para tarefas da fase de pré-visualização e text-to-3d-refine para tarefas da fase de aperfeiçoamento.
Name
model_urls
Type
object
Description
URL transferível para o ficheiro de modelo 3D texturizado gerado pela Meshy. A propriedade de um formato será omitida se o formato não for gerado, em vez de devolver uma string vazia.
Name
glb
Type
string
Description
URL transferível para o ficheiro GLB.
Name
fbx
Type
string
Description
URL transferível para o ficheiro FBX.
Name
usdz
Type
string
Description
URL transferível para o ficheiro USDZ.
Name
obj
Type
string
Description
URL transferível para o ficheiro OBJ.
Name
mtl
Type
string
Description
URL transferível para o ficheiro MTL.
Name
stl
Type
string
Description
URL transferível para o ficheiro STL.
Name
3mf
Type
string
Description
URL transferível para o ficheiro 3MF. Presente apenas quando 3mf foi solicitado através de 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 retrocompatibilidade. 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 retrocompatibilidade. Este campo não tem impacto funcional nos modelos gerados.
Name
texture_prompt
Type
string
Description
prompt de texto adicional fornecido para orientar o processo de texturização durante a fase de aperfeiçoamento.
Name
texture_image_url
Type
string
Description
URL transferível para a imagem de textura que foi usada para orientar o processo de texturização.
Name
thumbnail_url
Type
string
Description
URL transferível para a imagem de miniatura do ficheiro de modelo.
Name
alpha_thumbnail_url
Type
string
Description
URL transferível para 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 transferível para o vídeo de pré-visualização. Será removido numa versão futura.
Name
progress
Type
integer
Description
progress da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa for concluída com sucesso, passará a 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 tiver sido 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
a norma RFC 3339.
Por exemplo, sexta-feira, 1 de setembro de 2023, 12:00:00 GMT é representada 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
finished_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos. Se a tarefa ainda não estiver 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 de URL de textura gerados a partir da tarefa. Normalmente, contém apenas um objeto de URL de textura. Cada URL de textura tem as seguintes propriedades:
Name
base_color
Type
string
Description
URL transferível para a imagem do mapa de cor base.
Name
metallic
Type
string
Description
URL transferível para a imagem do mapa metálico.
Se a tarefa for criada com enable_pbr: false, esta propriedade será omitida.
Name
normal
Type
string
Description
URL transferível para a imagem do mapa de normais.
Se a tarefa for criada com enable_pbr: false, esta propriedade será omitida.
Name
roughness
Type
string
Description
URL transferível para a imagem do mapa de rugosidade.
Se a tarefa for criada com enable_pbr: false, esta propriedade será omitida.
Name
emission
Type
string
Description
URL transferível para a 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 apenas se o estado da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas falhadas. 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 estado da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Devolve 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,"seed":1234,"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}