Convert API

Ang Convert API ay nagbibigay-daan sa iyo na i-convert ang mga umiiral na 3D na modelo sa iba't ibang mga format ng file.

POST/openapi/v1/convert

Gumawa ng Convert Task

Ang endpoint na ito ay lumilikha ng bagong format conversion task.

Mga Parameter

Isa lamang sa input_task_id o model_url ang kailangan. Kung parehong ibinigay, ang input_task_id ang may priyoridad.

  • Name
    input_task_id
    Type
    string
    Kinakailangan
    Description

    Ang ID ng isang natapos na Meshy task na ang modelo ay nais mong i-convert. Ang task ay dapat may status na SUCCEEDED.

  • Name
    model_url
    Type
    string
    Kinakailangan
    Description

    Isang pampublikong URL o data URI na tumuturo sa isang 3D model file. Mga suportadong format: .glb, .gltf, .obj, .fbx, .stl. Para sa Data URIs, gamitin ang MIME type: application/octet-stream.

  • Name
    target_formats
    Type
    string[]
    Kinakailangan
    Description

    Isang listahan ng mga output format para sa na-convert na modelo. Mga magagamit na halaga: glb, fbx, obj, usdz, blend, stl, 3mf.

Mga Ibinabalik

Ang result na property ng tugon ay naglalaman ng id ng bagong likhang convert task.

Mga Paraan ng Pagkabigo

  • 400 - Bad Request

Ang kahilingan ay hindi katanggap-tanggap. Mga karaniwang sanhi:

  • Nawawalang parameter: Dapat ibigay ang alinman sa model_url o input_task_id.
  • Nawawalang target_formats: Dapat tukuyin ang kahit isang target format.
  • Di-wastong input task: Ang input_task_id ay dapat tumukoy sa isang matagumpay na task.
  • Di-wastong model format: Ang model_url ay tumuturo sa isang file na may hindi suportadong extension.
  • Hindi maabot na URL: Ang model_url ay hindi ma-download.
  • 401 - Unauthorized

Nabigo ang authentication. Pakisuri ang iyong API key.

  • 402 - Payment Required

Kulang ang credits para isagawa ang task na ito.

  • 429 - Too Many Requests

Lumampas ka sa iyong rate limit.

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

Kunin ang isang Convert Task

Ang endpoint na ito ay kumukuha ng isang convert task gamit ang ID nito.

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Ang ID ng convert task na kukunin.

Ibinabalik

Ang Convert Task object.

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

Burahin ang Isang Convert Task

Ang endpoint na ito ay permanenteng bubura ng isang convert task, kasama ang lahat ng kaugnay na modelo at data. Ang aksyong ito ay hindi na mababawi.

Path Parameters

  • Name
    id
    Type
    path
    Description

    Ang ID ng convert task na buburahin.

Returns

Nagbabalik ng 200 OK kapag matagumpay.

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

Listahan ng mga Gawain sa Pag-convert

Ang endpoint na ito ay nagbibigay-daan sa iyo na makuha ang listahan ng mga gawain sa pag-convert.

Mga Parameter

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Numero ng pahina para sa pagination.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Limitasyon sa laki ng pahina. Ang pinakamataas na pinapayagan ay 50 na item.

  • Name
    sort_by
    Type
    string
    Description

    Patlang na gagamitin para sa pag-aayos. Mga magagamit na halaga:

    • +created_at: Ayusin batay sa oras ng paglikha sa pataas na pagkakasunod-sunod.
    • -created_at: Ayusin batay sa oras ng paglikha sa pababang pagkakasunod-sunod.

Mga Ibinabalik

Nagbabalik ng isang listahan na may pagination ng The Convert Task Objects.

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

I-stream ang Convert Task

Ang endpoint na ito ay nag-i-stream ng real-time na updates para sa isang convert task gamit ang Server-Sent Events (SSE).

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Natatanging identifier para sa convert task na i-stream.

Mga Ibinabalik

Nagbabalik ng stream ng The Convert Task Objects bilang Server-Sent Events.

Para sa mga PENDING o IN_PROGRESS na tasks, ang response stream ay maglalaman lamang ng kinakailangang progress at status na mga field.

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
}

Ang Convert Task Object

Ang Convert Task object ay kumakatawan sa isang format conversion na trabaho.

Mga Katangian

  • id · string

Natatanging pagkakakilanlan para sa gawain.

  • type · string

Uri ng gawain. Ang halaga ay convert.

  • model_urls · object

Mga mada-download na URL para sa mga na-convert na model files. Tanging ang mga format na tinukoy sa target_formats ang magkakaroon ng mga URL. Ang iba pang mga katangian ng format ay magiging walang laman na mga string.

  • progress · integer

Pag-unlad ng gawain (0-100).

  • status · string

Katayuan ng gawain. Mga posibleng halaga: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • preceding_tasks · integer

Ang bilang ng mga naunang gawain. Makabuluhan lamang kapag ang status ay PENDING.

  • created_at · timestamp

Timestamp kung kailan nilikha ang gawain, sa milliseconds.

  • started_at · timestamp

Timestamp kung kailan sinimulan ang gawain, sa milliseconds. 0 kung hindi pa nasimulan.

  • finished_at · timestamp

Timestamp kung kailan natapos ang gawain, sa milliseconds. 0 kung hindi pa natapos.

  • task_error · object

Error object kung nabigo ang gawain. Tingnan ang Errors para sa karagdagang detalye.

  • consumed_credits · integer

Ang bilang ng credits na nagamit ng gawain na ito (1 credit bawat convert task). Nagbabalik ng 0 para sa mga FAILED na gawain.