Remesh API

A API Remesh permite que você faça o remesh e exporte modelos 3D existentes gerados por outras APIs da Meshy (como Imagem para 3D ou Texto para 3D) em vários formatos. Esta seção fornece detalhes sobre como usar a API Remesh.


POST/openapi/v1/remesh

Create a Remesh Task

Este endpoint cria uma nova tarefa de remesh.

Parâmetros

  • Name
    input_task_id
    Type
    string
    Obrigatório
    Description

    O ID da tarefa concluída de Imagem para 3D ou Texto para 3D que você deseja submeter ao remesh. Essa tarefa deve ser uma das seguintes: Text to 3D Preview, Text to 3D Refine, Imagem para 3D ou Retexturizar. Além disso, ela deve ter o status SUCCEEDED.

  • Name
    model_url
    Type
    string
    Obrigatório
    Description

    Forneça um modelo 3D para o Meshy realizar o remesh por meio de uma URL publicamente acessível ou data URI. Formatos suportados: .glb, .gltf, .obj, .fbx, .stl.

    Para Data URIs, use o MIME type: application/octet-stream.

  • Name
    target_formats
    Type
    string[]
    padrão ["glb"]
    Description

    Uma lista de formatos de destino para o modelo com remesh. Quando omitido, apenas GLB é gerado.

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

  • Name
    topology
    Type
    string
    padrão triangle
    Description

    Especifique a topology do modelo gerado.

    Valores disponíveis:

    • quad: Gera uma malha predominantemente quad.
    • triangle: Gera uma malha triangular decimada.
  • Name
    target_polycount
    Type
    integer
    padrão 30,000
    Description

    Especifique o número alvo de polígonos no modelo gerado. O número real de polígonos pode variar em relação ao alvo dependendo da complexidade da geometria.

    O intervalo de valores válido varia de acordo com o nível do usuário:

    • 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
    resize_height
    Type
    number
    obsoleto
    padrão 0
    Description

    Redimensiona o modelo para uma determinada altura medida em metros. Recomendamos usar a API de Redimensionar dedicada em vez disso.

  • Name
    resize_longest_side
    Type
    number
    obsoleto
    padrão 0
    Description

    Redimensiona o modelo de forma que a maior dimensão da bounding box seja igual ao valor especificado em metros. Recomendamos usar a API de Redimensionar dedicada em vez disso.

  • Name
    auto_size
    Type
    boolean
    obsoleto
    padrã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 de acordo. Recomendamos usar a API de Redimensionar dedicada em vez disso.

Aplica-se somente quando auto_size = true
  • Name
    origin_at
    Type
    string
    obsoleto
    padrão bottom
    Description

    Posição da origem. Recomendamos usar a API de Redimensionar dedicada em vez disso.

    Valores disponíveis: bottom, center.

  • Name
    convert_format_only
    Type
    boolean
    obsoleto
    Description

    Se true, o serviço apenas alterará o formato do arquivo do modelo de entrada, ignorando outras entradas como topology, resize_height e target_polycount. Recomendamos usar a API de Converter dedicada em vez disso.

  • Name
    alpha_thumbnail
    Type
    boolean
    padrão false
    Description

    Quando definido como true, a tarefa adicionalmente renderiza uma versão com fundo transparente (RGBA) da prévia e a retorna como alpha_thumbnail_url na resposta GET. O campo existente thumbnail_url permanece inalterado.

Retornos

A propriedade result da resposta contém o id da tarefa de remesh recém-criada.

Modos de Falha

  • Name
    400 - Bad Request
    Description

    A solicitação foi inaceitável. Causas comuns:

    • Parâmetro ausente: model_url ou input_task_id deve ser fornecido.
    • Tarefa de entrada inválida: input_task_id deve se referir a uma tarefa bem-sucedida de um modelo suportado.
    • Formato de modelo inválido: model_url aponta para um arquivo com uma extensão não suportada.
    • URL inacessível: Não foi possível baixar o model_url.
    • Topology inválida: O parâmetro topology é inválido.
    • Parâmetros mutuamente exclusivos: auto_size e resize_height não podem ser definidos simultaneamente.
  • 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/remesh
# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "resize_height": 1.0,
    "origin_at": "bottom"
  }'

# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "auto_size": true
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/remesh/:id

Recuperar uma Tarefa de Remesh

Este endpoint recupera uma tarefa de remesh pelo seu ID.

Parâmetros

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de remesh a ser recuperada.

Retornos

O objeto Remesh Task.

Request

GET
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

DELETE/openapi/v1/remesh/:id

Excluir uma Tarefa de Remesh

Este endpoint exclui permanentemente uma tarefa de remesh, incluindo todos os modelos e dados associados. Essa ação é irreversível.

Parâmetros de Path

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de remesh 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 solicitação é rejeitada com 409 Conflict e a tarefa continua em execução. Os créditos de uma tarefa que o worker já iniciou não são reembolsáveis, então excluí-la durante a execução custaria tanto os créditos quanto o resultado. Aguarde até que ela alcance o status SUCCEEDED, FAILED ou CANCELED e, 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/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -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/remesh

Listar Tarefas de Remesh

Este endpoint permite recuperar uma lista de tarefas de Remesh.

Parâmetros

  • Name
    page_num
    Type
    integer
    padrão 1
    Description

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

  • Name
    page_size
    Type
    integer
    padrão 10
    Description

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

  • Name
    sort_by
    Type
    string
    Description

    Campo pelo qual ordenar.

    Valores disponíveis:

    • +created_at: Ordenar pelo horário de criação em ordem crescente.
    • -created_at: Ordenar pelo horário de criação em ordem decrescente.

Retornos

Retorna uma lista paginada de Objetos de Tarefa de Remesh.

Request

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "remesh",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null
  }
]

GET/openapi/v1/remesh/:id/stream

Transmitir uma Tarefa de Remesh

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

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa de Remesh a ser transmitida.

Retornos

Retorna um stream de Objetos de Tarefa de Remesh como Server-Sent Events.

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

Request

GET
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/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": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
    "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

O Objeto da Tarefa de Remesh

O objeto da Tarefa de Remesh representa uma unidade de trabalho que a Meshy usa para reprocessar a malha (remesh) e exportar um modelo 3D existente em vários formatos. O objeto possui as seguintes propriedades:

Propriedades

  • Name
    id
    Type
    string
    Description

    Identificador único da tarefa. Embora usemos um UUID k-sortable para os 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 Remesh. O valor é remesh.

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

      URL para download do arquivo do Blender.

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

    URL para download de uma imagem de prévia renderizada a partir do modelo remesheado.

  • 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évia transparente foi renderizada com sucesso; caso contrário, esse campo é omitido.

  • Name
    progress
    Type
    integer
    Description

    Progresso da tarefa. Se a tarefa ainda não foi iniciada, essa propriedade será 0. Assim que a tarefa for concluída com sucesso, ela se tornará 100.

  • Name
    status
    Type
    string
    Description

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

  • Name
    preceding_tasks
    Type
    integer
    Description

    A contagem de tarefas precedentes.

  • Name
    created_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.

  • Name
    started_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não foi iniciada, essa propriedade será 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando a tarefa foi finalizada, em milissegundos. Se a tarefa ainda não foi finalizada, essa propriedade será 0.

  • 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 essa tarefa. Presente quando o status da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

Example Remesh Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5
}