API de Converter

A API de Converter permite-lhe converter modelos 3D existentes para formatos de ficheiro diferentes.

POST/openapi/v1/convert

Criar uma tarefa de Converter

Este endpoint cria uma nova tarefa de conversão de formato.

Parâmetros

Apenas um de input_task_id ou model_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 Meshy concluída cujo modelo deseja converter. A tarefa deve ter o estado SUCCEEDED.

  • Name
    model_url
    Type
    string
    Obrigatório
    Description

    Um URL publicamente acessível ou data URI que aponta para um ficheiro de modelo 3D. Formatos suportados: .glb, .gltf, .obj, .fbx, .stl. Para Data URIs, utilize o MIME type: application/octet-stream.

  • Name
    target_formats
    Type
    string[]
    Obrigatório
    Description

    Uma lista de formatos de saída para o modelo convertido. Valores disponíveis: glb, fbx, obj, usdz, blend, stl, 3mf.

Retornos

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

Modos de Falha

  • 400 - Bad Request

O pedido foi inaceitável. Causas comuns:

  • Parâmetro em falta: É necessário fornecer model_url ou input_task_id.
  • target_formats em falta: É necessário especificar pelo menos um formato de destino.
  • Tarefa de entrada inválida: O input_task_id deve referir-se a uma tarefa bem-sucedida.
  • 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.
  • 401 - Unauthorized

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

  • 402 - Payment Required

Créditos insuficientes para realizar esta tarefa.

  • 429 - Too Many Requests

Excedeu o seu limite de taxa.

Request

POST
/openapi/v1/convert
curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

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

Obter uma Tarefa de Conversão

Este endpoint obtém uma tarefa de conversão através do seu ID.

Parâmetros

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de conversão a obter.

Devolve

O objeto Convert Task.

Request

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

Response

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

Eliminar uma Tarefa de Conversão

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

Estado da Tarefa

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

Uma tarefa que já está 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á iniciou 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 elimine-a.

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

Devolve

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

Request

DELETE
/openapi/v1/convert/:id
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/convert/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/convert

Listar Tarefas de Conversão

Este endpoint permite obter uma lista de tarefas de conversão.

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 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 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 Conversão.

Request

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "convert",
    "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]
GET/openapi/v1/convert/:id/stream

Transmitir uma Tarefa de Conversão em Fluxo

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

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único da tarefa de conversão a transmitir.

Retorna

Retorna um fluxo de Objetos de Tarefa de Conversão como Server-Sent Events.

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

Request

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

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

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

O Objeto Convert Task

O objeto Convert Task representa um trabalho de conversão de formato.

Propriedades

  • id · string

Identificador único da tarefa.

  • type · string

Tipo da tarefa. O valor é convert.

  • model_urls · object

URLs para descarregar os ficheiros do modelo convertido. Apenas os formatos especificados em target_formats terão URLs. As restantes propriedades de formato serão strings vazias.

  • progress · integer

Progresso da tarefa (0-100).

  • status · string

Estado da tarefa. Valores possíveis: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • preceding_tasks · integer

A contagem de tarefas precedentes. Apenas relevante quando o estado é PENDING.

  • created_at · timestamp

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

  • started_at · timestamp

Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. 0 se ainda não tiver sido iniciada.

  • finished_at · timestamp

Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos. 0 se ainda não tiver sido concluída.

  • task_error · object

Objeto de erro caso a tarefa tenha falhado. Consulte Erros para mais detalhes.

  • consumed_credits · integer

O número de créditos consumidos por esta tarefa (1 crédito por tarefa de conversão). Devolve 0 para tarefas FAILED.