API de Imagem para 3D

A API de Imagem para 3D é um recurso que permite integrar as capacidades de Imagem para 3D da Meshy no seu próprio aplicativo. Nesta seção, você encontrará todas as informações que precisa para começar a usar esta API.


POST/openapi/v1/image-to-3d

Criar uma Tarefa de Imagem para 3D

Este endpoint permite criar uma nova tarefa de Imagem para 3D. Consulte o Objeto de Tarefa de Imagem para 3D para ver quais propriedades estão incluídas com o objeto de tarefa de Imagem para 3D.

Parâmetros

  • 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 usado 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 via a API, ter status de SUCCEEDED e produzir exatamente uma imagem.

  • Name
    image_url
    Type
    string
    Obrigatório
    Description

    Forneça uma imagem para a Meshy usar na criação do modelo. Atualmente, suportamos os formatos .jpg, .jpeg e .png.

    Existem duas maneiras de fornecer a imagem:

    • URL publicamente acessível: Um URL 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>.
  • 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 definição regular.
    • smart-topology: Escolha um modelo Smart Topology com ai_model (meshy-t1 ou meshy-t2).
    • lowpoly (obsoleto): Gera uma malha low-poly otimizada para polígonos mais limpos. Recomendamos o uso de smart-topology em vez disso.
  • Name
    ai_model
    Type
    string
    padrão latest
    Description

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

    Geração padrão (model_type: standard):

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

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

    • meshy-t2 (padrão, recomendado): o modelo Smart Topology — topology mais limpa, peças nativamente separadas, saída em triângulos e uma contagem de faces que você pode definir com target_polycount.
    • meshy-t1: o antigo modelo low-poly; não suporta definir uma contagem de faces com target_polycount.
  • Name
    ultra_mode
    Type
    boolean
    padrão false
    Description

    Habilita a geração Ultra para geometria de maior fidelidade com detalhes de superfície mais finos.

  • Name
    should_texture
    Type
    boolean
    padrão true
    Description

    Determina se texturas são geradas. Definindo como false pula a fase de textura, fornecendo uma malha sem texturas.

Aplica-se somente quando should_texture = true
  • Name
    enable_pbr
    Type
    boolean
    padrã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 for meshy-6, exceto em texture_resolution: 8k. meshy-7 e latest não produzem um mapa de emissão.

  • Name
    texture_resolution
    Type
    string
    padrã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 capturam mais detalhes de superfície.

  • 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 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 publicamente acessível: Um URL 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>
  • Name
    should_remesh
    Type
    boolean
    padrão false (meshy-6, meshy-7), true (outros)
    Description

    Controla se a fase Remesh deve ser habilitada. 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 dominante em quads.
    • triangle: Gera uma malha de triângulos decimada.
  • Name
    decimation_mode
    Type
    integer
    Description

    Habilita a decimação adaptativa definindo um nível de contagem de polígonos. Quando definido, target_polycount é ignorado.

    Valores disponíveis:

    • 1: Adaptativo — contagem ultra de polígonos.
    • 2: Adaptativo — contagem alta de polígonos.
    • 3: Adaptativo — contagem média de polígonos.
    • 4: Adaptativo — contagem baixa de polígonos.
  • Name
    save_pre_remeshed_model
    Type
    boolean
    padrão false
    Description

    Quando definido como true, a Meshy também armazena um arquivo GLB extra antes que a fase Remesh seja concluída.

  • Name
    target_polycount
    Type
    integer
    Description

    Número alvo de polígonos (faces) na saída. A contagem real pode desviar do alvo dependendo da geometria.

    target_polycount tem efeito em dois casos independentes:

    • Remesh — com should_remesh: true em um modelo standard. A malha é remesh (decimada) para aproximadamente essa contagem. Intervalo de 100 a 300.000, padrão de 30.000. Se decimation_mode for definido, ele tem prioridade e target_polycount é ignorado.
    • Smart Topology — com model_type: smart-topology e ai_model: meshy-t2. O modelo é gerado diretamente nessa contagem de faces; nenhuma remesh é executada e should_remesh não é necessário. Intervalo de 100 a 15.000, padrão de 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: Desabilita a simetria.
    • auto: Determina e aplica a simetria automaticamente com base na geometria de entrada.
    • on: Enforça a simetria durante a geração.
  • Name
    pose_mode
    Type
    string
    padrão ""
    Description

    Especifica o modo de pose para o modelo gerado.

    Valores disponíveis:

    • a-pose: Gera o modelo em pose A.
    • t-pose: Gera o modelo em pose T.
    • "" (string vazia): Nenhuma pose específica aplicada.
  • Name
    is_a_t_pose
    Type
    boolean
    obsoleto
    padrão false
    Description

    Use pose_mode em vez disso. Se deve gerar o modelo em pose A/T.

  • Name
    image_enhancement
    Type
    boolean
    padrã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.

  • Name
    remove_lighting
    Type
    boolean
    padrão true
    Description

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

  • Name
    moderation
    Type
    boolean
    padrão false
    Description

    Quando definido como true, o conteúdo de entrada será automaticamente filtrado para possível conteúdo prejudicial. Se conteúdo prejudicial for detectado, a tarefa não prosseguirá para a geração.

    O conteúdo das entradas image_url, texture_image_url e texture_prompt será verificado.

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

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

  • 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 redimensiona o modelo de acordo. A origem será bottom por padrão, a menos que origin_at seja definido explicitamente.

  • 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 GET. O campo thumbnail_url existente permanece inalterado.

  • Name
    multi_view_thumbnails
    Type
    boolean
    padrão false
    Description

    Quando definido como true, a tarefa também renderiza quatro miniaturas de visualização nos pontos cardeais (frente, direita, traseira, esquerda) e as retorna em thumbnail_urls na resposta GET. O campo thumbnail_url existente permanece inalterado e continua apontando para a visualização frontal, para que clientes existentes não sejam afetados.

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 Imagem para 3D.

Modos de Falha

  • Name
    400 - Bad Request
    Description

    A requisição não foi aceitável. Causas comuns:

    • Parâmetro ausente: É necessário fornecer image_url ou input_task_id.
    • Tarefa de entrada inválida: O input_task_id deve se referir a uma tarefa de Texto para Imagem ou Imagem para Imagem SUCCEEDED que produza exatamente uma imagem.
    • Formato de imagem inválido: O image_url fornecido não é um formato suportado (.jpg, .jpeg, .png).
    • URL inacessível: O image_url não pôde ser baixado (404 ou timeout).
    • Data URI inválido: A string base64 está malformada.
    • Combinação de parâmetros inválida: enable_pbr é suportado somente quando should_texture é verdade.
  • 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.

Requisição

POST
/openapi/v1/image-to-3d
# Solicitação simples com parâmetros obrigatórios
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

# Com Remesh, PBR e pose A
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -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"]
  }'

Response

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

GET/openapi/v1/image-to-3d/:id

Obter uma Tarefa de Imagem para 3D

Este endpoint permite obter uma tarefa de Imagem para 3D fornecido um id de tarefa válido. Consulte o Objeto de Tarefa de Imagem para 3D para ver quais propriedades estão incluídas com o 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.

Retornos

A resposta contém o objeto de tarefa de Imagem para 3D. Verifique a seção Objeto de Tarefa de Imagem para 3D para detalhes.

Requisição

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}

DELETE/openapi/v1/image-to-3d/:id

Excluir uma Tarefa de Imagem para 3D

Este endpoint exclui permanentemente uma tarefa de Imagem 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 Imagem para 3D a ser excluída.

Retornos

Retorna 200 OK em caso de sucesso.

Requisição

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

Response

// Retorna 200 Ok em caso de sucesso.

GET/openapi/v1/image-to-3d

Listar Tarefas de Imagem para 3D

Este endpoint permite recuperar uma lista de tarefas de Imagem para 3D.

Parâmetros

Atributos Opcionais

  • Name
    page_num
    Type
    integer
    Description

    Número da página para paginação. Começa e é padrão como 1.

  • Name
    page_size
    Type
    integer
    Description

    Limite do tamanho da página. Padrão de 10 itens. Máximo permitido é 50 itens.

  • Name
    sort_by
    Type
    string
    Description

    Campo para ordenar. Valores disponíveis:

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

Retornos

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

Requisição

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "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=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "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": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

Transmitir uma Tarefa de Imagem para 3D

Este endpoint transmite atualizações em tempo real para uma tarefa de Imagem para 3D usando Eventos Enviados pelo Servidor (SSE).

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único para a tarefa de Imagem para 3D a transmitir.

Retornos

Retorna uma transmissão de Objetos de Tarefa de Imagem para 3D como Eventos Enviados pelo Servidor.

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

Requisição

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

Response Stream

// Exemplo de evento de erro
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Exemplos de evento de mensagem ilustram o progresso da tarefa.
// Para tarefas PENDING ou IN_PROGRESS, a transmissão de resposta não incluirá todos os campos.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
  "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=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}

O Objeto de Tarefa de Imagem para 3D

O objeto de Tarefa de Imagem para 3D é uma unidade de trabalho que a Meshy rastreia para gerar um modelo 3D a partir de uma entrada de imagem. O objeto possui as seguintes propriedades:

Propriedades

  • Name
    id
    Type
    string
    Description

    Identificador único para a tarefa. Enquanto usamos um UUID classificável k 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 de Imagem para 3D. O valor é image-to-3d.

  • 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
      obj
      Type
      string
      Description

      URL para download do arquivo OBJ.

    • Name
      usdz
      Type
      string
      Description

      URL para download do arquivo USDZ.

    • Name
      mtl
      Type
      string
      Description

      URL para download do arquivo MTL, retornado ao lado das exportações OBJ quando texturas estão presentes.

    • 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
      pre_remeshed_glb
      Type
      string
      Description

      URL para download da saída GLB original antes do remeshing.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL para download da imagem em miniatura do arquivo de 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. Presente apenas quando a tarefa foi criada com alpha_thumbnail: true e o preview transparente foi renderizado com sucesso; caso contrário, este campo é omitido.

  • Name
    thumbnail_urls
    Type
    object
    Description

    URLs para download de quatro miniaturas de visualização nos pontos cardeais do modelo 3D gerado. Cada valor é um URL assinado para uma PNG de 512×512 renderizada com os mesmos materiais e iluminação de thumbnail_url. Útil para visualizar o modelo de múltiplos ângulos em pipelines de lote sem baixar o GLB.

    • Name
      front
      Type
      string
      Description

      Vista frontal, 0° de rotação ao redor do eixo vertical (corresponde a thumbnail_url).

    • Name
      right
      Type
      string
      Description

      Vista direita, 90° de rotação.

    • Name
      back
      Type
      string
      Description

      Vista traseira, 180° de rotação.

    • Name
      left
      Type
      string
      Description

      Vista esquerda, 270° de rotação.

  • 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

    Ecoa o valor de ultra_mode com o qual a tarefa foi criada. Presente apenas para tarefas meshy-7 (ou latest) que definem ultra_mode explicitamente; omitido caso contrário.

  • Name
    progress
    Type
    integer
    Description

    Progresso da tarefa. Se a tarefa ainda não tiver sido iniciada, esta 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 tiver sido iniciada, esta propriedade será 0.

  • 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 tiver sido concluída, esta propriedade será 0.

  • Name
    status
    Type
    string
    Description

    Status da tarefa. Possíveis valores são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Uma matriz 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 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.

    • Name
      normal
      Type
      string
      Description

      URL para download da imagem do mapa de normais.

    • Name
      roughness
      Type
      string
      Description

      URL para download da imagem do mapa de rugosidade.

    • Name
      emission
      Type
      string
      Description

      URL para download da imagem do mapa de emissão.

  • Name
    preceding_tasks
    Type
    integer
    Description

    A contagem de tarefas precedentes.

  • Name
    task_error
    Type
    object
    Description

    Detalhes de erro para tarefas com falha. 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 (créditos são reembolsados em caso de falha).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}