API Ubah Saiz

API Ubah Saiz membolehkan anda mengubah saiz model 3D sedia ada kepada dimensi dunia sebenar. Anda boleh menentukan ketinggian yang tepat, kekangan sisi terpanjang, atau biarkan AI secara automatik menganggarkan saiz yang sesuai.


POST/openapi/v1/resize

Buat Tugas Ubah Saiz

Endpoint ini mencipta tugas ubah saiz yang baru.

Parameter

  • Name
    input_task_id
    Type
    string
    Diperlukan
    Description

    ID tugas Meshy yang telah diselesaikan yang modelnya anda ingin ubah saiz. Tugas mesti mempunyai status SUCCEEDED. Format output akan menjadi GLB.

  • Name
    model_url
    Type
    string
    Diperlukan
    Description

    URL atau Data URI yang boleh diakses secara umum yang menunjuk kepada fail model 3D. Format yang disokong: .glb, .gltf, .obj, .fbx, .stl. Untuk Data URI, gunakan MIME type: application/octet-stream. Format output akan mengekalkan format asal model input.

  • Name
    resize_height
    Type
    number
    Description

    Ubah saiz model kepada ketinggian tertentu yang diukur dalam meter.

  • Name
    resize_longest_side
    Type
    number
    Description

    Ubah saiz model supaya sisi terpanjangnya sepadan dengan nilai ini, diukur dalam meter. Nisbah aspek dikekalkan.

  • Name
    auto_size
    Type
    boolean
    Description

    Apabila ditetapkan kepada true, perkhidmatan menggunakan visi AI untuk secara automatik menganggarkan ketinggian sebenar objek dan mengubah saiz model dengan sewajarnya. Titik asal akan ditetapkan kepada bottom melainkan origin_at ditetapkan secara eksplisit.

  • Name
    origin_at
    Type
    string
    lalai bottom
    Description

    Kedudukan titik asal selepas mengubah saiz.

    Nilai yang tersedia: bottom, center.

Pulangan

Properti result dalam respons mengandungi id tugas ubah saiz yang baru dicipta.

Mod Kegagalan

  • 400 - Bad Request

Permintaan tidak dapat diterima. Punca biasa:

  • Parameter hilang: Sama ada model_url atau input_task_id mesti disediakan.
  • Mode ubah saiz hilang: Sekurang-kurangnya satu daripada resize_height, resize_longest_side, atau auto_size mesti ditentukan.
  • Parameter saling eksklusif: resize_height, resize_longest_side, dan auto_size tidak boleh digabungkan.
  • Tugas input tidak sah: input_task_id mesti merujuk kepada tugas yang berjaya.
  • Format model tidak sah: model_url menunjuk kepada fail dengan sambungan yang tidak disokong.
  • URL tidak dapat dicapai: model_url tidak dapat dimuat turun.
  • 401 - Unauthorized

Pengesahan gagal. Sila semak kunci API anda.

  • 402 - Payment Required

Kredit tidak mencukupi untuk melaksanakan tugas ini.

  • 429 - Too Many Requests

Anda telah melebihi had kadar anda.

Permintaan

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"
  }'

Respons

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

GET/openapi/v1/resize/:id

Dapatkan Tugas Ubah Saiz

Endpoint ini mendapatkan tugas ubah saiz berdasarkan ID-nya.

Parameter

  • Name
    id
    Type
    path
    Description

    ID tugas ubah saiz yang ingin didapatkan.

Pulangan

Objek Tugas Ubah Saiz.

Permintaan

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

Respons

{
  "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

Padam Tugas Ubah Saiz

Endpoint ini memadamkan tugas ubah saiz secara kekal, termasuk semua model dan data yang berkaitan. Tindakan ini tidak boleh dipulihkan.

Parameter Laluan

  • Name
    id
    Type
    path
    Description

    ID tugas ubah saiz untuk dipadamkan.

Pemulangan

Memulangkan 200 OK jika berjaya.

Permintaan

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}"

Respons

// Returns 200 Ok on success.

GET/openapi/v1/resize

Senarai Tugas Ubah Saiz

Endpoint ini membolehkan anda mendapatkan senarai tugas ubah saiz.

Parameter

  • Name
    page_num
    Type
    integer
    lalai 1
    Description

    Nombor halaman untuk penomboran halaman.

  • Name
    page_size
    Type
    integer
    lalai 10
    Description

    Had saiz halaman. Maksimum yang dibenarkan adalah 50 item.

  • Name
    sort_by
    Type
    string
    Description

    Medan untuk disusun. Nilai yang tersedia:

    • +created_at: Susun mengikut masa penciptaan dalam urutan menaik.
    • -created_at: Susun mengikut masa penciptaan dalam urutan menurun.

Pulangan

Mengembalikan senarai berpenomboran bagi Objek Tugas Ubah Saiz.

Permintaan

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

Respons

[
  {
    "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

Strim Tugas Ubah Saiz

Endpoint ini menstrim kemas kini masa nyata untuk tugas ubah saiz menggunakan Server-Sent Events (SSE).

Parameter

  • Name
    id
    Type
    path
    Description

    Pengenal pasti unik untuk tugas ubah saiz yang ingin distrim.

Pulangan

Mengembalikan strim Objek Tugas Ubah Saiz sebagai Server-Sent Events.

Untuk tugas PENDING atau IN_PROGRESS, strim respons hanya akan menyertakan medan progress dan status yang diperlukan.

Permintaan

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}"

Strim Respons

// 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
}

Objek Tugas Ubah Saiz

Objek Tugas Ubah Saiz mewakili kerja ubah saiz.

Ciri-ciri

  • id · string

Pengenal unik untuk tugas ini.

  • type · string

Jenis tugas. Nilainya adalah resize.

  • model_urls · object

URL yang boleh dimuat turun untuk fail model yang telah diubah saiz. Apabila menggunakan input_task_id, output sentiasa GLB. Apabila menggunakan model_url, output mengekalkan format asal.

  • progress · integer

Kemajuan tugas (0-100).

  • status · string

Status tugas. Nilai yang mungkin: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • preceding_tasks · integer

Bilangan tugas terdahulu. Bermakna hanya apabila status adalah PENDING.

  • created_at · timestamp

Cap masa apabila tugas dicipta, dalam milisaat.

  • started_at · timestamp

Cap masa apabila tugas dimulakan, dalam milisaat. 0 jika tidak dimulakan.

  • finished_at · timestamp

Cap masa apabila tugas selesai, dalam milisaat. 0 jika tidak selesai.

  • task_error · object

Objek ralat jika tugas gagal. Lihat Ralat untuk maklumat lanjut.

  • consumed_credits · integer

Bilangan kredit yang digunakan oleh tugas ini (1 kredit setiap tugas ubah saiz). Mengembalikan 0 untuk tugas FAILED.