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


POST/openapi/v1/resize

Criar uma tarefa de Redimensionar

Este endpoint cria uma nova tarefa de redimensionamento.

Parâmetros

  • Name
    input_task_id
    Type
    string
    Obrigatório
    Description

    O ID de uma tarefa Meshy concluída cujo modelo pretende redimensionar. A tarefa tem de ter o estado SUCCEEDED. O formato de saída será GLB.

  • Name
    model_url
    Type
    string
    Obrigatório
    Description

    Um URL ou Data URI acessível publicamente 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. O formato de saída preservará o formato original do modelo de entrada.

  • Name
    resize_height
    Type
    number
    Description

    Redimensionar o modelo para uma altura específica medida em metros.

  • Name
    resize_longest_side
    Type
    number
    Description

    Redimensionar o modelo para que o seu lado mais comprido 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 e redimensionar o modelo em conformidade. A origem será predefinida como bottom, a menos que origin_at seja definido explicitamente.

  • Name
    origin_at
    Type
    string
    predefinição bottom
    Description

    Posição da origem após o redimensionamento.

    Valores disponíveis: bottom, center.

Devoluções

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

Modos de falha

  • 400 - Pedido incorreto

O pedido não foi aceite. Causas comuns:

  • Parâmetro em falta: Tem de ser fornecido model_url ou input_task_id.
  • Mode de redimensionamento em falta: Tem de ser especificado 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: 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 - Não autorizado

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

  • 402 - Pagamento necessário

Créditos insuficientes para executar esta tarefa.

  • 429 - Demasiados pedidos

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 Redimensionar

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

Parâmetros

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de redimensionamento a obter.

Devolve

O objeto da tarefa de Redimensionar.

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 Redimensionar

Este endpoint elimina permanentemente uma tarefa de redimensionamento, incluindo todos os modelos e dados associados. Esta ação é irreversível.

Parâmetros do caminho

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de redimensionamento a eliminar.

Devolve

Devolve 200 OK em caso de sucesso.

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

// Returns 200 Ok on success.

GET/openapi/v1/resize

Listar tarefas de Redimensionar

Este endpoint permite-lhe 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 de 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.

Devoluções

Devolve uma lista paginada de Objetos de tarefa de Redimensionar.

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 Redimensionar em streaming

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 em streaming.

Devolve

Devolve um fluxo de Objetos da tarefa de Redimensionar 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/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 da Tarefa Redimensionar

O objeto Tarefa Redimensionar representa uma tarefa de redimensionamento.

Propriedades

  • id · string

Identificador único da tarefa.

  • type · string

Tipo da tarefa. O valor é resize.

  • model_urls · object

URL transferível para o ficheiro do modelo redimensionado. Ao utilizar input_task_id, a saída é sempre GLB. Ao utilizar model_url, a saída 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. Significativo apenas 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 não tiver sido iniciada.

  • finished_at · timestamp

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 tiver falhado. 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 redimensionamento). Devolve 0 para tarefas FAILED.