API Analisar imprimibilidade

Analise um modelo 3D quanto à imprimibilidade FDM — estanquicidade, volume, furos, arestas non-manifold e faces degeneradas.

POST/openapi/v1/print/analyze

Create an Analyze Printability Task

Este endpoint cria uma nova tarefa de análise de imprimibilidade. A tarefa avalia um modelo 3D e reporta as suas métricas de imprimibilidade.

Se a tarefa de entrada já tiver imprimibilidade em cache, a tarefa devolvida fica imediatamente pronta e o primeiro GET sobre ela devolverá o resultado da análise sem passar pelo worker.

Parâmetros

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

  • Name
    model_url
    Type
    string
    Obrigatório
    Description

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

Retorna

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

Modos de Falha

  • Name
    400 - Bad Request
    Description

    O pedido foi inaceitável. Causas comuns:

    • Parâmetro em falta: nem input_task_id nem model_url foram fornecidos.
    • UUID inválido: input_task_id não é um UUID válido.
    • URL do modelo inválido: model_url está mal formatado, usa um esquema não suportado, ou tem uma extensão de ficheiro não suportada.
    • Ficheiro do modelo demasiado grande: o corpo de model_url excedeu 100 MB.
    • Tarefa não concluída com sucesso: a tarefa referenciada ainda está pendente, em curso, ou falhou.
  • Name
    401 - Unauthorized
    Description

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

  • Name
    403 - Forbidden
    Description

    A tarefa existe mas pertence a um utilizador diferente.

  • Name
    404 - Not Found
    Description

    Causas comuns:

    • A tarefa não existe ou foi eliminada.
    • A tarefa usa um modelo mais antigo que o Meshy 6, ou o seu mode não produz um asset 3D.
    • O ficheiro do modelo subjacente já não está disponível no armazenamento.
  • Name
    429 - Too Many Requests
    Description

    Excedeu a sua quota de tarefas pendentes ou o limite de taxa.

Request

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

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

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
GET/openapi/v1/print/analyze/:id

Retrieve an Analyze Printability Task

Este endpoint recupera uma tarefa de Analisar imprimibilidade através do seu ID.

Parâmetros

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de Analisar imprimibilidade a recuperar.

Retornos

O Objeto de Tarefa de Analisar imprimibilidade. O campo printability é null até a tarefa atingir SUCCEEDED.

Request

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-analyze",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1715725401000,
  "task_error": null,
  "printability": {
    "_version": "v1",
    "status": "warning",
    "issue_count": 1,
    "error_count": 0,
    "warning_count": 1,
    "metrics": {
      "is_watertight": true,
      "volume": 1.316167354292668,
      "non_manifold_edges": 0,
      "degenerate_faces": 43242,
      "holes": 0
    },
    "evaluated_at": 1700000001000
  },
  "consumed_credits": 0
}
DELETE/openapi/v1/print/analyze/:id

Eliminar uma tarefa de Analisar imprimibilidade

Este endpoint elimina permanentemente uma tarefa de análise de imprimibilidade e o respetivo resultado em cache. Esta ação é irreversível.

Parâmetros de Path

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de análise de imprimibilidade a eliminar.

Estado da tarefa

Uma tarefa que ainda esteja PENDING é eliminada e os créditos consumidos no momento da criação são reembolsados.

Uma tarefa que já esteja IN_PROGRESS não pode ser eliminada: o pedido é rejeitado com 409 Conflict e a tarefa continua a ser executada. Os créditos de uma tarefa que o worker já tenha iniciado não são reembolsáveis, pelo que eliminá-la a meio da execução custar-lhe-ia tanto os créditos como o resultado. Aguarde até que atinja o estado SUCCEEDED, FAILED ou CANCELED, e só depois a elimine.

Uma tarefa num estado terminal (SUCCEEDED, FAILED ou CANCELED) é eliminada sem reembolso.

Retorna

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

Request

DELETE
/openapi/v1/print/analyze/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/print/analyze/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/analyze

Listar tarefas de Analisar imprimibilidade

Este endpoint permite obter uma lista de tarefas de Analisar imprimibilidade.

Parâmetros

Atributos opcionais

  • Name
    page_num
    Type
    integer
    Description

    Número da página para paginação. Começa e assume por predefinição 1.

  • Name
    page_size
    Type
    integer
    Description

    Limite do tamanho da página. Por predefiniçã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 pela hora de criação em ordem ascendente.
    • -created_at: Ordenar pela hora de criação em ordem descendente.

Retorna

Retorna uma lista paginada de Objetos de Tarefa de Analisar imprimibilidade.

Request

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-analyze",
    "status": "SUCCEEDED",
    "progress": 100,
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "expires_at": 1715725401000,
    "task_error": null,
    "printability": {
      "_version": "v1",
      "status": "warning",
      "issue_count": 1,
      "error_count": 0,
      "warning_count": 1,
      "metrics": {
        "is_watertight": true,
        "volume": 1.316167354292668,
        "non_manifold_edges": 0,
        "degenerate_faces": 43242,
        "holes": 0
      },
      "evaluated_at": 1700000001000
    },
    "consumed_credits": 0
  }
]
GET/openapi/v1/print/analyze/:id/stream

Stream an Analyze Printability Task

Este endpoint transmite atualizações em tempo real para uma tarefa de análise de imprimibilidade utilizando Server-Sent Events (SSE).

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa de análise de imprimibilidade a transmitir.

Retorna

Retorna um fluxo de Objetos de Tarefa de Análise de Imprimibilidade como Server-Sent Events.

Cada frame transporta o objeto de tarefa completo para a etapa — a mesma estrutura que o endpoint Get retorna — pelo que, 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 printability só é enviado quando a tarefa atinge SUCCEEDED.

Request

GET
/openapi/v1/print/analyze/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/print/analyze/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-analyze",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1715725401000,
  "task_error": null,
  "printability": {
    "_version": "v1",
    "status": "warning",
    "issue_count": 1,
    "error_count": 0,
    "warning_count": 1,
    "metrics": {
      "is_watertight": true,
      "volume": 1.316167354292668,
      "non_manifold_edges": 0,
      "degenerate_faces": 43242,
      "holes": 0
    },
    "evaluated_at": 1700000001000
  },
  "consumed_credits": 0
}

The Analyze Printability Task Object

  • Name
    id
    Type
    string
    Description

    Identificador único para a tarefa. Embora utilizemos um UUID k-sortable para os ids das tarefas como detalhe de implementação, não deve fazer quaisquer suposições sobre o formato do id.

  • Name
    type
    Type
    string
    Description

    Tipo da tarefa de análise de imprimibilidade. O valor é print-analyze.

  • Name
    status
    Type
    string
    Description

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

  • Name
    progress
    Type
    integer
    Description

    Progress da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa for bem-sucedida, esta passará a ser 100.

  • Name
    preceding_tasks
    Type
    integer
    Description

    A contagem de tarefas precedentes.

    O valor deste campo só é relevante se o estado da tarefa for PENDING.

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

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

  • Name
    task_error
    Type
    object
    Description

    Informação 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 que descreve o que correu mal.

  • Name
    printability
    Type
    object
    Description

    Resultado da avaliação de imprimibilidade. null até que a tarefa atinja SUCCEEDED.

    • Name
      _version
      Type
      string
      Description

      Versão do esquema do resultado de imprimibilidade. Atualmente v1.

    • Name
      status
      Type
      string
      Description

      Estado geral. Um de:

      • healthy: sem erros e sem avisos.
      • warning: pelo menos um aviso, sem erros.
      • error: pelo menos um erro.
      • unknown: não foi possível analisar o modelo.
    • Name
      issue_count
      Type
      integer
      Description

      Contagem total de problemas, igual a error_count + warning_count.

    • Name
      error_count
      Type
      integer
      Description

      Número de problemas de nível de erro. Os erros são gerados quando o modelo não é watertight, tem volume não positivo, ou tem arestas non-manifold.

    • Name
      warning_count
      Type
      integer
      Description

      Número de problemas de nível de aviso. Os avisos são gerados quando o modelo contém faces degeneradas ou buracos.

    • Name
      metrics
      Type
      object
      Description

      Métricas de geometria em bruto devolvidas pelo avaliador.

      • Name
        is_watertight
        Type
        boolean
        Description

        true quando a malha não tem arestas de fronteira (ou seja, é fechada).

      • Name
        volume
        Type
        number
        Description

        Volume do modelo em metros cúbicos.

      • Name
        non_manifold_edges
        Type
        integer
        Description

        Contagem de arestas non-manifold.

      • Name
        degenerate_faces
        Type
        integer
        Description

        Contagem de faces degeneradas (faces com área zero ou inválidas).

      • Name
        holes
        Type
        integer
        Description

        Contagem de buracos (ciclos de fronteira) na malha.

    • Name
      evaluated_at
      Type
      timestamp
      Description

      Carimbo de data/hora de quando a análise foi calculada, em milissegundos desde o epoch.

  • Name
    consumed_credits
    Type
    integer
    Description

    Sempre 0. Este endpoint é gratuito.

The Analyze Printability Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-analyze",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1715725401000,
  "task_error": null,
  "printability": {
    "_version": "v1",
    "status": "warning",
    "issue_count": 1,
    "error_count": 0,
    "warning_count": 1,
    "metrics": {
      "is_watertight": true,
      "volume": 1.316167354292668,
      "non_manifold_edges": 0,
      "degenerate_faces": 43242,
      "holes": 0
    },
    "evaluated_at": 1700000001000
  },
  "consumed_credits": 0
}