API de Converter

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

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 pretende converter. A tarefa tem de ter um estado de 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.

Devolve

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 não era aceitável. Causas comuns:

Parâmetro em falta: Tem de ser fornecido model_url ou input_task_id.
target_formats em falta: Tem de ser especificado pelo menos um formato de destino.
Tarefa de entrada inválida: O input_task_id tem de 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 executar 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 Converter

Este endpoint obtém uma tarefa de Converter pelo respetivo ID.

Parâmetros

Name
id
Type
path
Description
O ID da tarefa de Converter a obter.

Devolve

O objeto da tarefa de Converter.

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 Converter

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

Devolve

Devolve 200 OK em caso de sucesso.

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

// Returns 200 Ok on success.

GET/openapi/v1/convert

Listar tarefas de Converter

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

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 é 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 Converter.

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 Converter em fluxo

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

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de Converter a transmitir em fluxo.

Devolve

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

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

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 de tarefa Converter

O objeto de tarefa Converter 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 de modelo convertidos. Apenas os formatos especificados em target_formats terão URLs. As outras propriedades de formato serão strings vazias.

progress · integer

progress da tarefa (0-100).

status · string

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

preceding_tasks · integer

A contagem das tarefas anteriores. Significativo apenas quando o estado é PENDING.

created_at · carimbo de data/hora

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

started_at · carimbo de data/hora

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

finished_at · carimbo de data/hora

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

task_error · object

Objeto de erro se a tarefa falhar. Consulte Erros para obter 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.