API de Texto para 3D

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, vai encontrar toda a informação de que precisa para começar a utilizar esta API.

O 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.


POST/openapi/v2/text-to-3d

Create a Text to 3D Preview Task

Este endpoint cria uma tarefa de pré-visualização de Texto para 3D, que gera uma malha 3D sem textura (apenas geometria) a partir de um prompt de texto. Este é o primeiro passo do fluxo de trabalho em duas etapas. Depois de a pré-visualização ser bem-sucedida, utilize o ID da tarefa devolvido para criar uma tarefa de refinamento para aplicar texturas. Consulte O Objeto de Tarefa Texto para 3D para obter 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 pré-visualização.

  • Name
    prompt
    Type
    string
    Obrigatório
    Description

    Descreva que tipo de objeto é o modelo 3D. Máximo de 800 caracteres.

  • Name
    model_type
    Type
    string
    predefinição standard
    Description

    Especifica 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 o modelo Smart Topology com ai_model (meshy-t2).
    • lowpoly (obsoleto): Gera malha low-poly otimizada para polígonos mais limpos. Recomendamos utilizar smart-topology em alternativa.
  • Name
    ai_model
    Type
    string
    predefinição latest
    Description

    ID do modelo a utilizar. Os valores disponíveis dependem de model_type.

    Geração standard (model_type: standard):

    • meshy-5, meshy-6, meshy-7, latest (Meshy 7)

    Geração Smart Topology (model_type: smart-topology):

    • meshy-t2 (predefinição): o modelo Smart Topology — topology mais limpa, partes separadas nativamente, resultado 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. A geração demora mais tempo e adiciona 5 créditos.

  • Name
    should_remesh
    Type
    boolean
    predefinição false (meshy-6, meshy-7), true (others)
    Description

    Controla se a fase de remesh é ativada. Para o modelo de mais alta qualidade, recomendamos definir should_remesh como false.

Aplica-se apenas quando should_remesh = true
  • Name
    topology
    Type
    string
    predefinição triangle
    Description

    Especifica a topology do modelo gerado.

    Valores disponíveis:

    • quad: Gera uma malha predominantemente quad.
    • 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: 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 alvo de polígonos (faces) no resultado. A contagem real pode divergir do alvo dependendo da geometria.

    target_polycount produz efeito em dois casos independentes:

    • Remesh — com should_remesh: true num modelo standard. A malha é submetida a remesh (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

    Especifica o pose_mode 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): Não é aplicada nenhuma pose específica.
  • 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
    art_style
    Type
    string
    obsoleto
    predefinição realistic
    Description

    Não suportado pelo Meshy-6. Os pedidos que utilizem o Meshy-6 irão ignorar art_style, e algumas combinações podem causar erros. Valores disponíveis: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    predefinição false
    Description

    Quando definido como true, o conteúdo de entrada será automaticamente analisado à procura de conteúdo potencialmente prejudicial. Se for detetado conteúdo prejudicial, a tarefa não avançará 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.

    Valores disponíveis: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    predefinição false
    Description

    Quando definido como true, a tarefa também renderiza 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
    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 assumirá bottom por predefinição, exceto se origin_at for explicitamente definido.

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.

Retorna

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

    O pedido foi inaceitável. Causas comuns:

    • Parâmetro em falta: Falta um parâmetro obrigatório (por exemplo, prompt, mode).
    • 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.

  • 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/v2/text-to-3d
# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with remesh and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

POST/openapi/v2/text-to-3d

Create a Text to 3D Refine Task

Este endpoint cria uma tarefa de refinamento 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 duas etapas.

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 indicada deve ser SUCCEEDED.

  • Name
    enable_pbr
    Type
    boolean
    predefinição false
    Description

    Gera mapas PBR (metallic, roughness, normal) além da cor base. Um emission map também é incluído quando ai_model é meshy-6, exceto em texture_resolution: 8k (não é produzido nenhum emission map). O meshy-7 (e latest) não produz um emission map.

  • 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 elevadas captam mais detalhe de superfície. Aplica-se apenas ao mode refine.

  • Name
    hd_texture
    Type
    boolean
    obsoleto
    predefinição false
    Description

    Utilize texture_resolution em vez disto — equivalente a texture_resolution: "4k". Quando ambos estão definidos, texture_resolution tem prioridade.

  • Name
    texture_prompt
    Type
    string
    Description

    Forneça um prompt de texto adicional para orientar o processo de texturização. Máximo de 800 carateres.

  • 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 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
    ai_model
    Type
    string
    predefinição latest
    Description

    ID do modelo a utilizar para o refinamento. Valores disponíveis: meshy-5, meshy-6, meshy-7, latest (Meshy 7).

  • Name
    moderation
    Type
    boolean
    predefinição false
    Description

    Quando definido como true, o conteúdo de entrada será automaticamente rastreado à procura de 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 rastreados.

  • Name
    remove_lighting
    Type
    boolean
    predefinição true
    Description

    Remove reflexos e sombras da textura de cor base, produzindo um resultado mais limpo que funciona melhor sob configurações de iluminação personalizadas.

  • Name
    target_formats
    Type
    string[]
    Description

    Especifica quais formatos de ficheiro 3D 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.

    Valores disponíveis: glb, obj, fbx, stl, usdz, 3mf

  • 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á, por defeito, bottom, a menos que origin_at seja explicitamente definido.

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 tarefa Texto para 3D recém-criada.

Modos de Falha

  • Name
    400 - Bad Request
    Description

    O pedido 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 pré-visualização ainda não foi concluída com sucesso.
    • 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 realizar esta tarefa.

  • Name
    404 - Not Found
    Description

    A tarefa de pré-visualização especificada por preview_task_id não foi encontrada.

  • Name
    429 - Too Many Requests
    Description

    Excedeu o seu limite de taxa.

Request

POST
/openapi/v2/text-to-3d
# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v2/text-to-3d/:id

Obter uma Tarefa de Texto para 3D

Este endpoint permite obter uma tarefa de Texto para 3D com base num 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 pré-visualização como de refinamento.

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa de Texto para 3D a obter.

Devolve

A resposta contém o objeto de tarefa de Texto para 3D. Consulte a secção O Objeto de Tarefa de Texto para 3D para mais detalhes.

Exemplos

ModoModelo de Exemplo
Pré-visualizaçãoPreview model
RefinamentoRefined model

Request

GET
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "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=***",
    "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=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "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=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

Eliminar uma Tarefa Texto para 3D

Este endpoint elimina 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 eliminar.

Retorno

Retorna 200 OK em caso de sucesso.

Request

DELETE
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v2/text-to-3d

Listar Tarefas de Texto para 3D

Este endpoint permite obter uma lista de tarefas de Texto para 3D.

Parâmetros

  • Name
    page_num
    Type
    integer
    predefinição 1
    Description

    Número da página para paginação.

  • Name
    page_size
    Type
    integer
    predefinição 10
    Description

    Limite do tamanho da página. O máximo permitido é 50 itens.

  • Name
    sort_by
    Type
    string
    Description

    Campo pelo qual ordenar.

    Valores disponíveis:

    • +created_at: Ordenar por hora de criação em ordem crescente.
    • -created_at: Ordenar por hora de criação em ordem decrescente.

Retorna

Retorna uma lista paginada de Objetos de Tarefa Texto para 3D.

Request

GET
/openapi/v2/text-to-3d
curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "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=***",
      "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=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "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=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

Fazer stream de uma tarefa Texto para 3D

Este endpoint transmite atualizações em tempo real de uma tarefa de Texto para 3D através de Server-Sent Events (SSE).

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa de Texto para 3D a transmitir.

Devoluções

Devolve um stream de Objetos de Tarefa de Texto para 3D como Server-Sent Events.

Para tarefas PENDING ou IN_PROGRESS, o stream de resposta incluirá apenas os campos progress e status necessários.

Request

GET
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"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 de tarefa Texto para 3D

O objeto de tarefa Texto para 3D é uma unidade de trabalho que a Meshy mantém sob controlo para gerar um modelo 3D a partir de uma entrada de texto. Existem duas etapas na API Texto para 3D, preview e refine. A etapa preview serve para gerar um modelo 3D apenas com malha, e a etapa refine serve para gerar um modelo 3D texturizado com base no resultado da etapa preview.

O objeto tem as seguintes propriedades:

Propriedades

  • Name
    id
    Type
    string
    Description

    Identificador único da tarefa. Embora utilizemos um UUID ordenável por k (k-sortable) para os ids de tarefa como detalhe de implementação, não deve fazer nenhuma suposição sobre o formato do id.

  • Name
    type
    Type
    string
    Description

    Tipo da tarefa Texto para 3D. Os valores possíveis são text-to-3d-preview para tarefas da etapa preview e text-to-3d-refine para tarefas da etapa refine.

  • Name
    model_urls
    Type
    object
    Description

    URL transferível para o ficheiro do 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. Apenas presente quando 3mf foi solicitado através de target_formats.

  • Name
    prompt
    Type
    string
    Description

    Este é o prompt não modificado que foi utilizado para criar a tarefa.

  • Name
    negative_prompt
    Type
    string
    obsoleto
    Description

    Mantido por motivos de compatibilidade retroativa. Este campo não tem qualquer impacto funcional nos modelos gerados.

  • Name
    art_style
    Type
    string
    obsoleto
    Description

    O art_style não modificado que foi utilizado para criar a tarefa preview. Não suportado pelo Meshy-6.

  • Name
    texture_richness
    Type
    string
    obsoleto
    Description

    Mantido por motivos de compatibilidade retroativa. Este campo não tem qualquer 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 etapa refine.

  • Name
    ultra_mode
    Type
    boolean
    Description

    Reflete o valor de ultra_mode com que a tarefa preview foi criada. Apenas presente para tarefas preview do meshy-7 (ou latest) que definam explicitamente ultra_mode; caso contrário, é omitido.

  • Name
    texture_image_url
    Type
    string
    Description

    URL transferível para a imagem de textura que foi utilizada para orientar o processo de texturização.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL transferível para a imagem de miniatura do ficheiro do modelo.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL transferível para 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
    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

    Progresso da tarefa. Se a tarefa ainda não tiver começado, esta propriedade será 0. Assim que a tarefa for concluída com sucesso, passará a ser 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 começado, esta propriedade será 0.

  • 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 tiver terminado, 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

    Uma matriz de objetos de URL de textura gerados a partir da tarefa. Normalmente, esta 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.

    • Name
      normal
      Type
      string
      Description

      URL transferível para a imagem do mapa de normais.

    • Name
      roughness
      Type
      string
      Description

      URL transferível para a imagem do mapa de rugosidade.

    • Name
      emission
      Type
      string
      Description

      URL transferível para a imagem do mapa de emissão.

  • Name
    preceding_tasks
    Type
    integer
    Description

    A contagem de tarefas precedentes.

  • 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,
  "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
}