API de Reparar imprimibilidade

Repare um modelo 3D para imprimibilidade em FDM — corrija arestas non-manifold, faces degeneradas, buracos e outros problemas de topology para que a malha fique pronta para impressão.


POST/openapi/v1/print/repair

Create a Repair Printability Task

Este endpoint cria uma nova tarefa de reparo de imprimibilidade. A tarefa executa o reparo de topology em um modelo 3D e retorna uma versão estanque (watertight) e pronta para impressão.

O formato de saída corresponde ao formato de entrada. Se você enviar um .stl via model_url, o model_urls.stl da resposta conterá a malha reparada e os demais campos de formato ficarão vazios. O caminho input_task_id sempre lê o GLB da tarefa de origem, então a saída é .glb.

Parâmetros

  • Name
    model_url
    Type
    string
    Obrigatório
    Description

    URL de um modelo 3D a ser reparado. Formatos suportados: .glb, .gltf, .obj, .fbx, .stl. Tamanho máximo do arquivo: 100 MB. Deve usar http, https ou uma URL data: (URLs de dados ignoram as verificações de extensão).

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

Retornos

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

Modos de Falha

  • Name
    400 - Bad Request
    Description

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

    • Parâmetro ausente: nem input_task_id nem model_url foram fornecidos.
    • UUID inválido: input_task_id não é um UUID válido.
    • URL de modelo inválida: model_url está malformada, usa um esquema não suportado ou tem uma extensão de arquivo não suportada.
    • Arquivo de modelo muito grande: o corpo de model_url excedeu 100 MB.
    • Tarefa não bem-sucedida: a tarefa referenciada ainda está pendente, em andamento ou falhou.
    • GLB ausente: a tarefa referenciada não possui um asset GLB para reparar.
  • Name
    401 - Unauthorized
    Description

    Falha na autenticação. Verifique sua chave de API.

  • Name
    402 - Payment Required
    Description

    Causas comuns:

    • Plano gratuito: a criação de tarefas requer um plano pago. Faça upgrade na página de assinatura.
    • Créditos insuficientes: o limite de créditos do espaço de trabalho foi atingido.
  • Name
    404 - Not Found
    Description

    A tarefa referenciada não existe ou pertence a outro usuário.

  • Name
    429 - Too Many Requests
    Description

    Você excedeu sua cota de tarefas pendentes ou o limite de taxa.

Request

POST
/openapi/v1/print/repair
# Repair an existing task
curl https://api.meshy.ai/openapi/v1/print/repair \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

# Or repair a model URL directly
curl https://api.meshy.ai/openapi/v1/print/repair \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.stl"
  }'

Response

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

GET/openapi/v1/print/repair/:id

Recuperar uma Tarefa de Reparar Imprimibilidade

Este endpoint recupera uma tarefa de reparar imprimibilidade pelo seu ID.

Parâmetros

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de reparar imprimibilidade a ser recuperada.

Retornos

O Objeto de Tarefa de Reparar Imprimibilidade. O bloco model_urls fica vazio até a tarefa atingir SUCCEEDED. Apenas o campo model_urls correspondente ao formato de entrada é preenchido.

Request

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "",
    "gltf": "",
    "fbx": "",
    "obj": "",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}

DELETE/openapi/v1/print/repair/:id

Excluir uma Tarefa de Reparar Imprimibilidade

Este endpoint exclui permanentemente uma tarefa de reparar imprimibilidade e sua saída reparada. Esta ação é irreversível.

Parâmetros de Caminho

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de reparar imprimibilidade 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. Créditos de uma tarefa que o worker já iniciou não são reembolsáveis, então excluí-la no meio da execução custaria tanto os créditos quanto o resultado. Aguarde até que ela alcance 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/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/print/repair/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/print/repair

List Repair Printability Tasks

Este endpoint permite recuperar uma lista de tarefas de reparo de imprimibilidade.

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 tamanho da 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: Ordenar por horário de criação em ordem crescente.
    • -created_at: Ordenar por horário de criação em ordem decrescente.

Retornos

Retorna uma lista paginada de Objetos de Tarefa de Reparar Imprimibilidade.

Request

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-repair",
    "status": "SUCCEEDED",
    "progress": 100,
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000030000,
    "expires_at": 1715725401000,
    "task_error": null,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "gltf": "",
      "fbx": "",
      "obj": "",
      "stl": "",
      "usdz": "",
      "3mf": "",
      "mtl": ""
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
    "texture_urls": [],
    "consumed_credits": 10
  }
]

GET/openapi/v1/print/repair/:id/stream

Transmitir uma Tarefa de Reparar Imprimibilidade

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

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa de reparar imprimibilidade a ser transmitida.

Retornos

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

Cada frame transporta o objeto completo da tarefa referente ao estágio atual — o mesmo formato retornado pelo endpoint Get — portanto, enquanto a tarefa estiver PENDING ou IN_PROGRESS, os campos de saída simplesmente ainda não estão preenchidos (null, [] ou {}) e finished_at é null. O bloco model_urls é enviado somente quando a tarefa atinge SUCCEEDED.

Request

GET
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/print/repair/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.
// Every frame is the full task object; fields not yet populated are null / empty.
// The PENDING frame below is abbreviated to the fields that change.
event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***",
    "gltf": "",
    "fbx": "",
    "obj": "",
    "stl": "",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}

O Objeto de Tarefa Repair Printability

  • Name
    id
    Type
    string
    Description

    Identificador único da tarefa. Embora usemos um UUID k-sortable para os ids de tarefas 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 reparar imprimibilidade. O valor é print-repair.

  • Name
    status
    Type
    string
    Description

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

  • 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
    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
    expires_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando o resultado da tarefa expirará do sistema, em milissegundos. 0 se a tarefa ainda não tiver sido finalizada.

  • Name
    task_error
    Type
    object
    Description

    Informações de erro caso a tarefa tenha falhado. Esta propriedade é null se a tarefa não tiver falhado. Consulte Erros para mais detalhes.

    • Name
      message
      Type
      string
      Description

      Mensagem de erro descrevendo o que deu errado.

  • Name
    model_urls
    Type
    object
    Description

    URLs para download do modelo 3D reparado. Apenas o campo correspondente ao formato de entrada é preenchido; os demais campos de formato ficam com strings vazias.

    • Name
      glb
      Type
      string
      Description

      URL para download do GLB reparado. Preenchido quando a entrada era um GLB ou quando input_task_id foi usado.

    • Name
      gltf
      Type
      string
      Description

      URL para download do GLTF reparado. Preenchido quando a entrada era um upload de GLTF.

    • Name
      fbx
      Type
      string
      Description

      URL para download do FBX reparado. Preenchido quando a entrada era um upload de FBX.

    • Name
      obj
      Type
      string
      Description

      URL para download do OBJ reparado. Preenchido quando a entrada era um upload de OBJ.

    • Name
      stl
      Type
      string
      Description

      URL para download do STL reparado. Preenchido quando a entrada era um upload de STL.

    • Name
      usdz
      Type
      string
      Description

      Reservado para saída em USDZ. Sempre uma string vazia para tarefas de reparar imprimibilidade.

    • Name
      3mf
      Type
      string
      Description

      Reservado para saída em 3MF. Sempre uma string vazia para tarefas de reparar imprimibilidade.

    • Name
      mtl
      Type
      string
      Description

      Reservado para saída em MTL. Sempre uma string vazia para tarefas de reparar imprimibilidade.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL de uma imagem de pré-visualização renderizada a partir do modelo reparado.

  • 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
    texture_urls
    Type
    array
    Description

    Sempre um array vazio. O reparo preserva apenas a geometria de entrada e não regenera texturas.

  • Name
    consumed_credits
    Type
    integer
    Description

    O número de créditos consumidos por esta tarefa. 10 assim que a tarefa atingir SUCCEEDED. Retorna 0 para tarefas com FAILED (os créditos são reembolsados em caso de falha).

The Repair Printability Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "gltf": "",
    "fbx": "",
    "obj": "",
    "stl": "",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}