API de Remesh

A API de Remesh permite-lhe refazer a malha e exportar modelos 3D existentes gerados por outras APIs da Meshy (como Imagem para 3D ou Texto para 3D) para vários formatos. Esta secção fornece detalhes sobre como utilizar a API de Remesh.


POST/openapi/v1/remesh

Criar uma tarefa de Remesh

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 à qual pretende aplicar Remesh. Esta tarefa deve ser uma das seguintes tarefas: Pré-visualização de Texto para 3D, Refinar Texto para 3D, Imagem para 3D ou Retexturizar. Além disso, deve ter o estado SUCCEEDED.

  • Name
    model_url
    Type
    string
    Obrigatório
    Description

    Forneça um modelo 3D para o Meshy refazer a malha através de um URL acessível publicamente ou de um Data URI. Formatos suportados: .glb, .gltf, .obj, .fbx, .stl.

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

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

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

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

  • Name
    topology
    Type
    string
    predefinição triangle
    Description

    Especifique a topology do modelo gerado.

    Valores disponíveis:

    • quad: Gera uma malha predominantemente quadrilateral.
    • 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 elevada.
    • 3: Adaptativo — contagem de polígonos média.
    • 4: Adaptativo — contagem de polígonos baixa.
  • Name
    resize_height
    Type
    number
    obsoleto
    predefinição 0
    Description

    Redimensiona o modelo para uma determinada altura medida em metros. Recomendamos utilizar a API Redimensionar dedicada em alternativa.

  • Name
    resize_longest_side
    Type
    number
    obsoleto
    predefinição 0
    Description

    Redimensiona o modelo para que a dimensão mais longa da caixa delimitadora seja igual ao valor especificado em metros. Recomendamos utilizar a API Redimensionar dedicada em alternativa.

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

    Quando definido como true, o serviço utiliza visão por IA para estimar automaticamente a altura real do objeto e redimensionar o modelo em conformidade. Recomendamos utilizar a API Redimensionar dedicada em alternativa.

Aplica-se apenas quando auto_size = true
  • Name
    origin_at
    Type
    string
    obsoleto
    predefinição bottom
    Description

    Posição da origem. Recomendamos utilizar a API Redimensionar dedicada em alternativa.

    Valores disponíveis: bottom, center.

  • Name
    convert_format_only
    Type
    boolean
    obsoleto
    Description

    Se true, o serviço irá apenas alterar o formato do ficheiro do modelo de entrada, ignorando outras entradas como topology, resize_height e target_polycount. Recomendamos utilizar a API Converter dedicada em alternativa.

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

Devolve

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

Modos de falha

  • Name
    400 - Bad Request
    Description

    O pedido não foi aceitável. Causas comuns:

    • Parâmetro em falta: Deve ser fornecido model_url ou input_task_id.
    • Tarefa de entrada inválida: O input_task_id deve referir-se a uma tarefa bem-sucedida de um modelo suportado.
    • Formato de modelo inválido: O model_url aponta para um ficheiro com uma extensão não suportada.
    • URL inacessível: Não foi possível transferir o model_url.
    • Topology inválida: O parâmetro topology é inválido.
    • Parâmetros mutuamente exclusivos: auto_size e resize_height não podem estar ambos definidos.
  • Name
    401 - Unauthorized
    Description

    A autenticação falhou. Verifique a sua chave de API.

  • Name
    402 - Payment Required
    Description

    Créditos insuficientes para realizar esta tarefa.

  • Name
    429 - Too Many Requests
    Description

    Excedeu o seu limite de taxa.

Request

POST
/openapi/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

Obter uma tarefa Remesh

Este endpoint obtém uma tarefa Remesh pelo respetivo ID.

Parâmetros

  • Name
    id
    Type
    path
    Description

    O ID da tarefa Remesh a obter.

Devolve

O objeto da tarefa Remesh.

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

Eliminar uma tarefa de Remesh

Este endpoint elimina permanentemente uma tarefa de remesh, 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 remesh a eliminar.

Devolve

Devolve 200 OK em caso de sucesso.

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

// Returns 200 Ok on success.

GET/openapi/v1/remesh

Listar tarefas de Remesh

Este endpoint permite-lhe obter uma lista de tarefas de Remesh.

Parâmetros

  • Name
    page_num
    Type
    integer
    predefinição 1
    Description

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

  • Name
    page_size
    Type
    integer
    predefinição 10
    Description

    Limite de tamanho da página. O máximo permitido é de 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 Os 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 Remesh

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

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa Remesh a transmitir.

Devoluções

Devolve um fluxo de Os objetos de tarefa Remesh como Server-Sent Events.

Para tarefas PENDING ou IN_PROGRESS, o fluxo da 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 de tarefa Remesh

O objeto de tarefa Remesh representa uma unidade de trabalho que a Meshy utiliza para executar Remesh e exportar um modelo 3D existente para vários formatos. O objeto tem as seguintes propriedades:

Properties

  • Name
    id
    Type
    string
    Description

    Identificador único da tarefa. Embora utilizemos 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 de Remesh. O valor é remesh.

  • Name
    model_urls
    Type
    object
    Description

    URL descarregável para o ficheiro do modelo 3D texturizado gerado pela Meshy. A propriedade de um formato será omitida se o formato não for gerado, em vez de devolver uma cadeia 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
      blend
      Type
      string
      Description

      URL descarregável para o ficheiro Blender.

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

    URL descarregável para uma imagem de pré-visualização renderizada a partir do modelo com malha refeita.

  • 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 sucesso; caso contrário, este campo é omitido.

  • 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 tiver sido concluída com sucesso, passará a ser 100.

  • Name
    status
    Type
    string
    Description

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

  • Name
    preceding_tasks
    Type
    integer
    Description

    O número de tarefas anteriores.

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

  • 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
    task_error
    Type
    object
    Description

    Detalhes do erro para tarefas falhadas. Consulte Erros para a referência completa do objeto task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    O número de créditos consumidos por esta tarefa. Presente quando o estado da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

Example 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
}