API de Redimensionar

A API de Redimensionar permite-lhe redimensionar modelos 3D existentes para dimensões reais. Pode especificar uma altura exata, uma restrição do lado mais longo, ou deixar que a IA estime automaticamente o tamanho apropriado.

POST/openapi/v1/resize

Create a Resize Task

Este endpoint cria uma nova tarefa de redimensionamento.

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 redimensionar. A tarefa deve ter o estado SUCCEEDED. O formato de saída será GLB.

Name
model_url
Type
string
Obrigatório
Description
Um URL publicamente acessível ou um data URI que aponte para um ficheiro de modelo 3D. Formatos suportados: .glb, .gltf, .obj, .fbx, .stl. Para Data URIs, utilize o MIME type: application/octet-stream. O formato de saída irá preservar o formato original do modelo de entrada.

É obrigatório exatamente um mode de redimensionamento: resize_height, resize_longest_side ou auto_size. Estes três parâmetros são mutuamente exclusivos.

Name
resize_height
Type
number
Description
Redimensiona o modelo para uma altura específica, medida em metros.

Name
resize_longest_side
Type
number
Description
Redimensiona o modelo de forma a que o seu lado mais longo corresponda a este valor, medido em metros. A proporção é preservada.

Name
auto_size
Type
boolean
Description
Quando definido como true, o serviço utiliza visão por IA para estimar automaticamente a altura real do objeto no mundo real e redimensiona o modelo de acordo. A origem terá por predefinição bottom, exceto se origin_at for explicitamente definido.

Name
origin_at
Type
string
predefinição bottom
Description
Posição da origem após o redimensionamento.
Valores disponíveis: bottom, center.

Retorna

A propriedade result da resposta contém o id da tarefa de redimensionamento 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.
Mode de redimensionamento em falta: É necessário especificar pelo menos um de resize_height, resize_longest_side ou auto_size.
Parâmetros mutuamente exclusivos: resize_height, resize_longest_side e auto_size não podem ser combinados.
Tarefa de entrada inválida: input_task_id deve referir-se a uma tarefa concluída com sucesso.
Formato de modelo inválido: model_url aponta para um ficheiro com uma extensão não suportada.
URL inacessível: Não foi possível descarregar o model_url.

401 - Unauthorized

A autenticação falhou. Por favor, 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/resize

# Simple: resize to a specific height
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "resize_height": 1.8
  }'

# Advanced: resize longest side with custom origin
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.glb",
    "resize_longest_side": 2.0,
    "origin_at": "center"
  }'

Response

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

GET/openapi/v1/resize/:id

Obter uma Tarefa de Redimensionamento

Este endpoint obtém uma tarefa de redimensionamento através do seu ID.

Parâmetros

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

Devolve

O objeto da Tarefa de Redimensionamento.

Request

GET

/openapi/v1/resize/:id

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

Response

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

DELETE/openapi/v1/resize/:id

Eliminar uma Tarefa de Redimensionamento

Este endpoint elimina permanentemente uma tarefa de redimensionamento, 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 redimensionamento 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 em execução. 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.

Retorna

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

Request

DELETE

/openapi/v1/resize/:id

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

List Resize Tasks

Este endpoint permite obter uma lista de tarefas de redimensionamento.

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 por ordem ascendente.
- -created_at: Ordenar pela hora de criação por ordem descendente.

Retorna

Retorna uma lista paginada de The Resize Task Objects.

Request

GET

/openapi/v1/resize

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

Response

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

GET/openapi/v1/resize/:id/stream

Transmitir uma Tarefa de Redimensionamento

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

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de redimensionamento a transmitir.

Retorna

Retorna um fluxo de Objetos de Tarefa de Redimensionamento 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/resize/:id/stream

curl -N https://api.meshy.ai/openapi/v1/resize/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": "resize",
  "model_urls": {
    "glb": "https://assets.meshy.ai/.../model.glb?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

O Objeto Resize Task

O objeto Resize Task representa uma tarefa de redimensionamento.

Propriedades

id · string

Identificador único da tarefa.

type · string

Tipo da tarefa. O valor é resize.

model_urls · object

URL para transferência do ficheiro do modelo redimensionado. Ao usar input_task_id, o resultado é sempre GLB. Ao usar model_url, o resultado preserva o formato original.

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 de tarefas precedentes. Apenas relevante quando o estado é PENDING.

created_at · timestamp

Carimbo de data/hora da criação da tarefa, em milissegundos.

started_at · timestamp

Carimbo de data/hora do início da tarefa, em milissegundos. 0 se ainda não tiver começado.

finished_at · timestamp

Carimbo de data/hora da conclusão da tarefa, em milissegundos. 0 se ainda não tiver terminado.

task_error · object

Objeto de erro se a tarefa falhar. Consulte Erros para mais detalhes.

consumed_credits · integer

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