API de Imagem para 3D

A API de Imagem para 3D é uma funcionalidade que lhe permite integrar as capacidades de Imagem 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.

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

Criar uma tarefa Imagem para 3D

Este endpoint permite-lhe criar uma nova tarefa Imagem para 3D. Consulte O objeto da tarefa Imagem para 3D para ver quais as propriedades incluídas no objeto da tarefa Imagem para 3D.

Parâmetros

Apenas um de input_task_id ou image_url é obrigatório. Se ambos forem fornecidos, input_task_id tem prioridade.

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 tarefas: Texto para imagem ou Imagem para imagem. Além disso, deve ter sido executada através da API, ter um estado 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 formas de fornecer a imagem:
- URL acessível publicamente: 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
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 com elevado nível de detalhe.
- lowpoly: Gera uma malha low-poly otimizada para polígonos mais limpos.
Quando lowpoly está selecionado, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model são ignorados.
Name
ai_model
Type
string
predefinição latest
Description
ID do modelo a usar. Valores disponíveis: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
predefinição true
Description
Determina se as texturas são geradas. Defini-lo como false ignora a fase de textura, fornecendo uma malha sem texturas.

Aplica-se apenas quando should_texture = true

Name
enable_pbr
Type
boolean
predefinição false
Description
Gere 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
Gere a textura de cor base com resolução 4K (4096×4096) para maior detalhe.
Suportado apenas quando ai_model é meshy-6 ou latest. Os mapas PBR são sempre gerados a 2K.
Name
texture_prompt
Type
string
Description
Forneça um prompt de texto 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 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>
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 usado para orientar o processo de texturização. Se ambos os parâmetros forem fornecidos, então texture_prompt será usado por predefinição para texturizar o modelo. A texturização através de texto ou imagem custará 10 créditos por tarefa.

Name
should_remesh
Type
boolean
predefinição false (meshy-6), true (others)
Description
Controla se a fase de Remesh deve ser ativada. Quando definido como false, a API devolve 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 quadrangular.
- 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 alta.
- 3: Adaptativo — contagem de polígonos média.
- 4: Adaptativo — contagem de polígonos baixa.
Name
save_pre_remeshed_model
Type
boolean
predefinição false
Description
Quando definido como true, a Meshy também armazena um ficheiro GLB adicional antes de a fase de Remesh terminar.

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.
- on: Impõe simetria durante a geração.
Name
pose_mode
Type
string
predefinição ""
Description
Especifique o mode de pose do modelo gerado.
Valores disponíveis:
- a-pose: Gera o modelo numa pose A.
- t-pose: Gera o modelo numa pose T.
- "" (cadeia vazia): Nenhuma pose específica aplicada.
Name
is_a_t_pose
Type
boolean
⚠ obsoleto
predefinição false
Description
Use pose_mode em alternativa. Define se o modelo deve ser gerado numa pose A/T.
Name
image_enhancement
Type
boolean
predefinição true
Description
Otimiza a imagem de entrada para obter melhores resultados. Defina como false para preservar o aspeto exato da imagem de entrada sem qualquer processamento de estilo.
Suportado apenas quando ai_model é meshy-6 ou latest.
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
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.
O conteúdo das entradas image_url, texture_image_url e texture_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
Quando omitido, todos os formatos exceto 3mf são gerados. 3mf só é incluído quando explicitamente especificado.
Name
auto_size
Type
boolean
predefinição false
Description
Quando definido como true, o serviço usa 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.
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
multi_view_thumbnails
Type
boolean
predefinição false
Description
Quando definido como true, a tarefa renderiza adicionalmente quatro miniaturas de vistas cardeais (frente, direita, trás, esquerda) e devolve-as em thumbnail_urls na resposta GET. O campo thumbnail_url existente permanece inalterado e continua a apontar para a vista frontal, pelo que os clientes existentes não são afetados.
Adiciona aproximadamente 3 segundos à latência da tarefa.

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

Modos de falha

Name
400 - Bad Request
Description
O pedido era inaceitável. Causas comuns:
- Parâmetro em falta: Deve ser fornecido image_url ou input_task_id.
- Tarefa de entrada inválida: O input_task_id deve referir-se a uma tarefa Texto para imagem ou Imagem para imagem com estado 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: Não foi possível descarregar o image_url (404 ou timeout).
- Data URI inválido: A cadeia base64 está malformada.
- Combinação de parâmetros inválida: enable_pbr só é suportado quando should_texture é true.
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
429 - Too Many Requests
Description
Excedeu o seu limite de taxa.

Request

POST

/openapi/v1/image-to-3d

# Simple request with required params
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>"
  }'

# With remesh, PBR, and A-pose
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 Imagem para 3D

Este endpoint permite-lhe obter uma tarefa Imagem para 3D dado um id de tarefa válido. Consulte O Objeto de Tarefa Imagem para 3D para ver quais propriedades estão incluídas no objeto de tarefa Imagem para 3D.

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa Imagem para 3D a obter.

Devolve

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

Request

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

Eliminar uma tarefa de Imagem para 3D

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

Devolve

Devolve 200 OK em caso de sucesso.

Request

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

// Returns 200 Ok on success.

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

Listar tarefas de Imagem para 3D

Este endpoint permite-lhe obter 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 em 1 e o valor predefinido é 1.
Name
page_size
Type
integer
Description
Limite do tamanho da página. O valor predefinido é 10 itens. 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 por ordem ascendente.
- -created_at: Ordenar por hora de criação por ordem descendente.

Devolve

Devolve uma lista paginada de Objetos de tarefa de Imagem para 3D.

Request

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 em fluxo uma tarefa de Imagem para 3D

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

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de Imagem para 3D a transmitir em fluxo.

Retorna

Retorna um fluxo de Os objetos de tarefa de Imagem para 3D como Server-Sent Events.

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

Request

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

// 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",
  "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 acompanha para gerar um modelo 3D a partir de uma entrada de imagem. O objeto tem as seguintes propriedades:

Propriedades

Name
id
Type
string
Description
Identificador único da tarefa. Embora usemos um UUID k-sortable para os IDs das tarefas como detalhe de implementação, não deve fazer quaisquer pressupostos sobre o formato do ID.
Name
type
Type
string
Description
Tipo da tarefa Imagem para 3D. O valor é image-to-3d.
Name
model_urls
Type
object
Description
URL descarregável para o ficheiro do modelo 3D com textura 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 descarregável para o ficheiro GLB.
- Name
  fbx
  Type
  string
  Description
  URL descarregável para o ficheiro FBX.
- Name
  obj
  Type
  string
  Description
  URL descarregável para o ficheiro OBJ.
- Name
  usdz
  Type
  string
  Description
  URL descarregável para o ficheiro USDZ.
- Name
  mtl
  Type
  string
  Description
  URL descarregável para o ficheiro MTL, devolvido juntamente com exportações OBJ quando existem texturas.
- Name
  stl
  Type
  string
  Description
  URL descarregável para o ficheiro STL.
- Name
  3mf
  Type
  string
  Description
  URL descarregável para o ficheiro 3MF. Presente apenas quando 3mf foi solicitado através de target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  URL descarregável para a saída GLB original antes da remesh.
  Disponível apenas quando a tarefa foi criada com should_remesh: true e save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL descarregável para a imagem de miniatura do ficheiro do modelo. Equivalente a thumbnail_urls.front quando presente, mantida para retrocompatibilidade.
Name
alpha_thumbnail_url
Type
string
Description
URL descarregá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 êxito; caso contrário, este campo é omitido.
Name
thumbnail_urls
Type
object
Description
URLs descarregáveis para quatro miniaturas de vistas cardinais do modelo 3D gerado. Cada valor é um URL assinado para um PNG 512×512 renderizado com os mesmos materiais e iluminação que thumbnail_url. Útil para pré-visualizar o modelo a partir de vários ângulos em pipelines em lote sem descarregar o GLB.
Presente apenas quando a tarefa foi criada com multi_view_thumbnails: true e atingiu SUCCEEDED. Tarefas mais antigas e tarefas criadas sem a adesão não incluirão este campo.
- Name
  front
  Type
  string
  Description
  Vista frontal, rotação de 0° em torno do eixo vertical (corresponde a thumbnail_url).
- Name
  right
  Type
  string
  Description
  Vista direita, rotação de 90°.
- Name
  back
  Type
  string
  Description
  Vista posterior, rotação de 180°.
- Name
  left
  Type
  string
  Description
  Vista esquerda, rotação de 270°.
Name
texture_prompt
Type
string
Description
O prompt de texto que foi utilizado para orientar o processo de texturização.
Name
texture_image_url
Type
string
Description
URL descarregável para a imagem de textura que foi utilizada para orientar o processo de texturização.
Name
progress
Type
integer
Description
Progresso da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa for concluída com êxito, 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
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
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 que são 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 descarregável para a imagem do mapa de cor base.
- Name
  metallic
  Type
  string
  Description
  URL descarregá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 descarregá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 descarregá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 descarregá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
O número de tarefas anteriores.
O valor deste campo só é significativo se o estado da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes de 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 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
}