I-convert API

Pinapayagan ka ng I-convert API na I-convert ang mga kasalukuyang 3D model sa iba't ibang file format.

POST/openapi/v1/convert

Gumawa ng I-convert Task

Lumilikha ang endpoint na ito ng bagong task para sa pag-convert ng format.

Mga Parameter

Isa lang sa input_task_id o model_url ang kailangan. Kung parehong ibinigay, inuuna ang input_task_id.

  • Name
    input_task_id
    Type
    string
    Kinakailangan
    Description

    Ang ID ng isang nakumpletong Meshy task na ang model ay gusto mong i-convert. Dapat may status na SUCCEEDED ang task.

  • Name
    model_url
    Type
    string
    Kinakailangan
    Description

    Isang publicly accessible 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 model. Mga available na value: glb, fbx, obj, usdz, blend, stl, 3mf.

Ibinabalik

Ang result property ng response ay naglalaman ng id ng bagong gawang convert task.

Mga Failure Mode

  • 400 - Bad Request

Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:

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

Nabigo ang authentication. Pakisuri ang iyong API key.

  • 402 - Payment Required

Hindi sapat ang credits para maisagawa 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 I-convert Task

Kinukuha ng endpoint na ito ang isang convert task gamit ang ID nito.

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Ang ID ng convert task na kukunin.

Ibinabalik

Ang object ng I-convert Task.

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

Mag-delete ng I-convert na Task

Permanenteng dine-delete ng endpoint na ito ang isang I-convert na task, kasama ang lahat ng nauugnay na modelo at data. Hindi na mababawi ang aksyong ito.

Mga Parameter ng Path

  • Name
    id
    Type
    path
    Description

    Ang ID ng I-convert na task na ide-delete.

Ibinabalik

Ibinabalik ang 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

Ilista ang mga Task sa I-convert

Pinapayagan ka ng endpoint na ito na kunin ang listahan ng mga task sa I-convert.

Mga Parameter

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Numero ng page para sa pagination.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Limitasyon sa laki ng page. Ang maximum na pinapayagan ay 50 item.

  • Name
    sort_by
    Type
    string
    Description

    Field na pagbabatayan ng pag-sort. Mga available na value:

    • +created_at: I-sort ayon sa oras ng paggawa sa pataas na order.
    • -created_at: I-sort ayon sa oras ng paggawa sa pababang order.

Mga Ibinabalik

Nagbabalik ng listahang may pagination ng Mga Object ng Task sa I-convert.

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 isang I-convert na Task

Ang endpoint na ito ay nag-i-stream ng mga real-time na update 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 ii-stream.

Mga Ibinabalik

Nagbabalik ng stream ng Mga Object ng I-convert na Task bilang Server-Sent Events.

Para sa mga task na PENDING o IN_PROGRESS, isasama lang ng response stream ang kinakailangang mga field na progress at status.

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 I-convert Task Object

Ang I-convert Task object ay kumakatawan sa isang trabaho ng pag-i-convert ng format.

Mga Property

  • id · string

Natatanging identifier para sa gawain.

  • type · string

Uri ng gawain. Ang value ay convert.

  • model_urls · object

Mga nada-download na URL para sa mga na-convert na model file. Tanging ang mga format na tinukoy sa target_formats ang magkakaroon ng mga URL. Ang ibang format properties ay magiging mga empty string.

  • progress · integer

Progress ng gawain (0-100).

  • status · string

Status ng gawain. Mga posibleng value: 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 ginawa ang gawain, sa milliseconds.

  • started_at · timestamp

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

  • finished_at · timestamp

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

  • task_error · object

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

  • consumed_credits · integer

Ang bilang ng credits na nakonsumo ng gawaing ito (1 credit bawat gawaing pag-I-convert). Nagbabalik ng 0 para sa mga gawaing FAILED.