API de Imagem para 3D

A API de Imagem para 3D é um recurso que permite integrar os recursos de Imagem para 3D da Meshy em sua própria aplicação. Nesta seção, você encontrará todas as informações necessárias para começar a usar esta API.

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

Create an Image to 3D Task

Este endpoint permite criar uma nova tarefa de Imagem para 3D. 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

Apenas um dos parâmetros 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 cuja saída deve ser usada como imagem de entrada. Essa tarefa deve ser uma das seguintes: Texto para imagem ou Imagem para imagem. Além disso, ela deve ter sido executada via API, ter o status SUCCEEDED e produzir exatamente uma imagem.

Name
image_url
Type
string
Obrigatório
Description
Forneça uma imagem para o Meshy usar na criação do modelo. Atualmente oferecemos suporte aos formatos .jpg, .jpeg e .png.
Há duas maneiras de fornecer a imagem:
- URL publicamente acessível: Uma URL que é acessível pela internet pública.
- Data URI: Um data URI da imagem codificado em base64. Exemplo de um data URI: data:image/jpeg;base64,<seus dados de imagem codificados em base64>.

Name
model_type
Type
string
padrão standard
Description
Especifica o tipo de geração de malha 3D.
Valores disponíveis:
- standard: Geração de malha 3D regular de alto detalhe.
- smart-topology: Escolha um modelo Smart Topology com ai_model (meshy-t2).
- lowpoly (obsoleto): Gera malha low-poly otimizada para polígonos mais limpos. Recomendamos usar smart-topology em vez disso.
Quando smart-topology é selecionado, topology, should_remesh e save_pre_remeshed_model são ignorados.
Quando lowpoly é selecionado, ai_model, topology, target_polycount, should_remesh e save_pre_remeshed_model são ignorados.
Name
ai_model
Type
string
padrão latest
Description
ID do modelo a ser usado. Os valores disponíveis dependem de model_type.
Geração standard (model_type: standard):
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (obsoleto): use meshy-7.1 em vez disso.
Geração Smart Topology (model_type: smart-topology):
- meshy-t2 (padrão): o modelo Smart Topology — topology mais limpa, partes nativamente separadas, saída em triângulos e uma contagem de faces que você pode definir com target_polycount.
Name
geometry_resolution
Type
string
padrão standard
Description
Passagem de geração de geometria. 2k executa a passagem Ultra em 2048³; 4k a executa em 4096³ para o detalhe de superfície mais refinado.
Valores disponíveis: standard, 2k, 4k
Requer meshy-7.1 ou latest.
Name
ultra_mode
Type
boolean
⚠ obsoleto
padrão false
Description
Use geometry_resolution em vez disso. ultra_mode: true é equivalente a geometry_resolution: "2k".
Name
should_texture
Type
boolean
padrão true
Description
Determina se as texturas são geradas. Definir como false ignora 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 é meshy-6, exceto em texture_resolution: 8k. meshy-6-lite, meshy-7.1 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 opção entre 2k (2048×2048), 4k (4096×4096) ou 8k (8192×8192). Resoluções mais altas capturam mais detalhes de superfície.
4k e 8k não estão disponíveis com ai_model meshy-6-lite. Em 8k, nenhum mapa de emissão é produzido.
Name
hd_texture
Type
boolean
⚠ obsoleto
padrão false
Description
Use texture_resolution em vez disso — equivalente a texture_resolution: "4k". Quando ambos são definidos, texture_resolution tem precedência.
Name
texture_prompt
Type
string
Description
Forneça um prompt de texto para guiar o processo de texturização. Máximo de 800 caracteres.
Name
texture_image_url
Type
string
Description
Forneça uma imagem 2d para guiar o processo de texturização. Atualmente oferecemos suporte aos formatos .jpg, .jpeg e .png.
Há duas maneiras de fornecer a imagem:
- URL publicamente acessível: Uma URL que é acessível pela internet pública
- Data URI: Um data URI da imagem codificado em base64. Exemplo de um data URI: data:image/jpeg;base64,<seus dados de imagem codificados em base64>
A texturização por imagem pode não funcionar de forma ideal se houver diferenças substanciais de geometria entre o asset original e a imagem enviada. Apenas um dos parâmetros texture_image_url ou texture_prompt pode ser usado para guiar o processo de texturização. Se ambos os parâmetros forem fornecidos, texture_prompt será usado por padrão para texturizar o modelo. Texturizar via texto ou imagem custará 10 créditos por tarefa.

Name
should_remesh
Type
boolean
padrão false (Meshy 6 and Meshy 7 models), true (others)
Description
Controla se a fase de remesh deve ser habilitada. Para o modelo de maior qualidade, recomendamos definir should_remesh como false.

Aplica-se somente quando should_remesh = true

Name
topology
Type
string
padrão triangle
Description
Especifica a topology do modelo gerado.
Valores disponíveis:
- quad: Gera uma malha predominantemente de quadriláteros.
- triangle: Gera uma malha triangular 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 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
padrão false
Description
Quando definido como true, o Meshy também armazena um arquivo GLB extra antes da conclusão da fase de remesh.

Name
target_polycount
Type
integer
Description
Número alvo de polígonos (faces) na saída. A contagem real pode divergir do alvo dependendo da geometria.
target_polycount tem efeito em dois casos independentes:
- Remesh — com should_remesh: true em um modelo standard. A malha é remesheada (decimada) para aproximadamente essa contagem. Faixa de 100 a 300.000, padrão 30.000. Se decimation_mode estiver definido, ele tem prioridade e target_polycount é ignorado.
- Smart Topology — com model_type: smart-topology e ai_model: meshy-t2. O modelo é gerado diretamente nessa contagem de faces; nenhum remesh é executado e should_remesh não é necessário. Faixa de 100 a 15.000, padrão 4.000.

Name
symmetry_mode
Type
string
⚠ obsoleto
padrão auto
Description
Obsoleto. Este parâmetro não afeta mais a saída.
O campo symmetry_mode controla o comportamento de simetria durante o processo de geração do modelo.
Os valores válidos são:
- off: Desabilita 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
padrão ""
Description
Especifica o mode de pose do modelo gerado.
Valores disponíveis:
- a-pose: Gera o modelo em uma pose A.
- t-pose: Gera o modelo em uma 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 uma pose A/T.
Name
image_enhancement
Type
boolean
padrão true
Description
Otimiza a imagem de entrada para obter melhores resultados. Defina como false para preservar a aparência exata da imagem de entrada sem qualquer processamento de estilo.
Suportado apenas quando ai_model é meshy-6, meshy-7.1 ou latest.
Name
remove_lighting
Type
boolean
padrão true
Description
Remove realces e sombras da textura de cor base, produzindo um resultado mais limpo que funciona melhor em configurações de iluminação personalizadas.
Suportado apenas quando ai_model é meshy-6.
Name
moderation
Type
boolean
padrão false
Description
Quando definido como true, o conteúdo de entrada será automaticamente verificado em busca de conteúdo potencialmente prejudicial. Se conteúdo prejudicial for detectado, a tarefa não prosseguirá para a geração.
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. Apenas os formatos solicitados serão gerados e retornados, o que pode reduzir o tempo de conclusão da tarefa. Quando omitido, todos os formatos suportados são incluídos.
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
padrão false
Description
Quando definido como true, o serviço usa visão de IA para estimar automaticamente a altura real do objeto e redimensionar o modelo de acordo. A origem terá como padrão bottom, a menos que origin_at seja explicitamente definido.
Name
alpha_thumbnail
Type
boolean
padrão false
Description
Quando definido como true, a tarefa renderiza adicionalmente uma versão com fundo transparente (RGBA) da pré-visualização 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 renderiza adicionalmente quatro miniaturas de vistas cardeais (frontal, direita, traseira, esquerda) e as retorna em thumbnail_urls na resposta GET. O campo thumbnail_url existente permanece inalterado e continua apontando para a vista frontal, então clientes existentes não são afetados.
Adiciona aproximadamente 3 segundos à latência da tarefa.

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 solicitação foi inaceitável. Causas comuns:
- Parâmetro ausente: image_url ou input_task_id deve ser fornecido.
- Tarefa de entrada inválida: input_task_id deve referenciar uma tarefa SUCCEEDED de Texto para imagem ou Imagem para imagem que produza exatamente uma imagem.
- Formato de imagem inválido: O image_url fornecido não está em um formato suportado (.jpg, .jpeg, .png).
- URL inacessível: Não foi possível baixar o image_url (404 ou timeout).
- Data URI inválido: A string base64 está malformada.
- Combinação de parâmetros inválida: enable_pbr só é suportado quando should_texture é true.
- Modelo não suportado para low poly: ai_model: "meshy-6-lite" não suporta model_type: "lowpoly".
- Modelo não suportado para Ultra: geometry_resolution requer meshy-7.1 ou latest.
Name
401 - Unauthorized
Description
Falha na autenticação. Verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
429 - Too Many Requests
Description
Você excedeu 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 Ultra 4K geometry, 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>",
    "ai_model": "meshy-7.1",
    "geometry_resolution": "4k",
    "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

Recuperar uma Tarefa de Imagem para 3D

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

Parâmetros

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

Retornos

A resposta contém o objeto de tarefa de Imagem para 3D. Consulte a seção O Objeto de Tarefa de Imagem para 3D para mais 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

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.

Status da Tarefa

Uma tarefa que ainda está PENDING é excluída e os créditos consumidos no momento da criação são reembolsados.

Uma tarefa que já está IN_PROGRESS não pode ser excluída: a requisição é rejeitada com 409 Conflict e a tarefa continua em execução. Os créditos de uma tarefa que o worker já começou a processar não são reembolsáveis, portanto excluí-la no meio da execução custaria tanto os créditos quanto o resultado. Aguarde até que ela alcance SUCCEEDED, FAILED ou CANCELED, então exclua-a.

Uma tarefa em um estado terminal (SUCCEEDED, FAILED ou CANCELED) é excluída sem reembolso.

Retornos

Retorna 200 OK em caso de sucesso, ou 409 Conflict quando a tarefa está IN_PROGRESS.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

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

List Image to 3D Tasks

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 tem como padrão 1.
Name
page_size
Type
integer
Description
Limite de itens por página. O padrão é 10 itens. O máximo permitido é 100 itens.
Name
sort_by
Type
string
Description
Campo pelo qual ordenar. Valores disponíveis:
- +created_at: Ordena pelo horário de criação em ordem crescente.
- -created_at: Ordena pelo horário de criação em ordem decrescente.

Retornos

Retorna uma lista paginada de The Image to 3D Task Objects.

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 uma Tarefa de Imagem para 3D

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

Parâmetros

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

Retornos

Retorna um stream de Objetos de Tarefa de Imagem para 3D como Server-Sent Events.

Para tarefas PENDING ou IN_PROGRESS, o stream 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 monitora 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 da tarefa. Embora usemos um UUID ordenável por k (k-sortable) como detalhe de implementação para os ids de tarefa, você não deve fazer nenhuma suposição 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 do modelo 3D texturizado gerado pela Meshy. A propriedade de um formato será omitida caso o formato não tenha sido 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 junto com as exportações OBJ quando há texturas 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 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 para download da imagem de miniatura do arquivo do modelo. Equivalente a thumbnail_urls.front quando presente, mantido para compatibilidade com versões anteriores.
Name
alpha_thumbnail_url
Type
string
Description
URL para download de uma versão com fundo transparente (RGBA) de thumbnail_url. Presente apenas quando a tarefa foi criada com alpha_thumbnail: true e a pré-visualização transparente foi renderizada com sucesso; caso contrário, este campo é omitido.
Name
thumbnail_urls
Type
object
Description
URLs para download de quatro miniaturas de visualização nos pontos cardeais do modelo 3D gerado. Cada valor é uma URL assinada para um PNG de 512×512 renderizado com os mesmos materiais e iluminação de thumbnail_url. Útil para pré-visualizar o modelo em múltiplos ângulos em pipelines em lote sem precisar baixar o GLB.
Presente apenas quando a tarefa foi criada com multi_view_thumbnails: true e atingiu o status SUCCEEDED. Tarefas mais antigas e tarefas criadas sem essa opçã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 traseira, 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 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
⚠ obsoleto
Description
Obsoleto; use geometry_resolution em vez disso.
Name
geometry_resolution
Type
string
Description
O nível Ultra em que a tarefa foi executada (2k ou 4k); omitido para standard.
Name
progress
Type
integer
Description
Progresso da tarefa. Se a tarefa ainda não tiver sido iniciada, essa propriedade será 0. Depois que a tarefa for concluída com sucesso, ela se tornará 100.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não tiver sido iniciada, essa propriedade será 0.
Um carimbo de data/hora representa o número de milissegundos decorridos desde 1º de janeiro de 1970 UTC, seguindo o padrão RFC 3339. Por exemplo, sexta-feira, 1º de setembro de 2023, 12:00:00 GMT é representado como 1693569600000. Isso se aplica a todos os carimbos de data/hora na Meshy API.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.
Name
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, essa propriedade será 0.
Name
status
Type
string
Description
Status da tarefa. Os valores possíveis são um dos seguintes: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Um array de objetos de URL de textura gerados a partir da tarefa. Normalmente, ele contém apenas um objeto de URL de textura. Cada URL de textura possui as seguintes propriedades:
- Name
  base_color
  Type
  string
  Description
  URL para download da imagem do mapa de cor base.
- Name
  metallic
  Type
  string
  Description
  URL para download da imagem do mapa metálico.
  Se a tarefa for criada com enable_pbr: false, essa propriedade será omitida.
- Name
  normal
  Type
  string
  Description
  URL para download da imagem do mapa de normais.
  Se a tarefa for criada com enable_pbr: false, essa propriedade será omitida.
- Name
  roughness
  Type
  string
  Description
  URL para download da imagem do mapa de rugosidade.
  Se a tarefa for criada com enable_pbr: false, essa propriedade será omitida.
- Name
  emission
  Type
  string
  Description
  URL para download da imagem do mapa de emissão.
  Se a tarefa for criada com enable_pbr: false, ou se ai_model for meshy-6-lite, meshy-7.1, ou latest, essa propriedade será omitida.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes.
O valor deste campo é significativo apenas se o status da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes de erro para tarefas com falha. Consulte Erros para a referência completa do objeto task_error.
Name
consumed_credits
Type
integer
Description
O número de créditos consumidos por esta tarefa. Presente quando o status da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Retorna 0 para tarefas com status 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
}