Dönüştür API'si

Dönüştür API'si, mevcut 3D modelleri farklı dosya biçimlerine dönüştürmenize olanak tanır.

POST/openapi/v1/convert

Dönüştür Görevi Oluştur

Bu uç nokta yeni bir biçim dönüştürme görevi oluşturur.

Parametreler

input_task_id veya model_url seçeneklerinden yalnızca biri gereklidir. İkisi de sağlanırsa, input_task_id öncelik alır.

Name
input_task_id
Type
string
Zorunlu
Description
Dönüştürmek istediğiniz modeli içeren tamamlanmış bir Meshy görevinin ID'si. Görevin durumu SUCCEEDED olmalıdır.

Name
model_url
Type
string
Zorunlu
Description
3D model dosyasına işaret eden herkese açık bir URL veya Data URI. Desteklenen biçimler: .glb, .gltf, .obj, .fbx, .stl. Data URI'leri için şu MIME type değerini kullanın: application/octet-stream.

Name
target_formats
Type
string[]
Zorunlu
Description
Dönüştürülen model için çıktı biçimlerinin listesi. Kullanılabilir değerler: glb, fbx, obj, usdz, blend, stl, 3mf.

Döndürür

Yanıtın result özelliği, yeni oluşturulan dönüştürme görevinin id değerini içerir.

Hata Durumları

400 - Bad Request

İstek kabul edilemezdi. Yaygın nedenler:

Eksik parametre: model_url veya input_task_id sağlanmalıdır.
Eksik target_formats: En az bir hedef biçim belirtilmelidir.
Geçersiz giriş görevi: input_task_id başarılı bir göreve başvurmalıdır.
Geçersiz model biçimi: model_url, desteklenmeyen uzantıya sahip bir dosyaya işaret ediyor.
Ulaşılamayan URL: model_url indirilemedi.

401 - Unauthorized

Kimlik doğrulama başarısız oldu. Lütfen API anahtarınızı kontrol edin.

402 - Payment Required

Bu görevi gerçekleştirmek için yetersiz kredi.

429 - Too Many Requests

Hız sınırınızı aştınız.

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

Dönüştür Görevini Alma

Bu uç nokta, bir dönüştür görevini ID'sine göre alır.

Parametreler

Name
id
Type
path
Description
Alınacak dönüştür görevinin ID'si.

Döndürür

Dönüştür Görevi nesnesi.

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

Bir Dönüştür Görevini Sil

Bu uç nokta, ilişkili tüm modeller ve veriler dahil olmak üzere bir dönüştür görevini kalıcı olarak siler. Bu eylem geri alınamaz.

Yol Parametreleri

Name
id
Type
path
Description
Silinecek dönüştür görevinin ID'si.

Döndürür

Başarılı olduğunda 200 OK döndürür.

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

Dönüştür Görevlerini Listele

Bu uç nokta, dönüştür görevlerinin listesini almanızı sağlar.

Parametreler

Name
page_num
Type
integer
varsayılan 1
Description
Sayfalama için sayfa numarası.

Name
page_size
Type
integer
varsayılan 10
Description
Sayfa boyutu sınırı. İzin verilen maksimum değer 50 öğedir.

Name
sort_by
Type
string
Description
Sıralama yapılacak alan. Kullanılabilir değerler:
- +created_at: Oluşturulma zamanına göre artan sırada sırala.
- -created_at: Oluşturulma zamanına göre azalan sırada sırala.

Dönen Değerler

Sayfalanmış bir Dönüştür Görevi Nesneleri listesi döndürür.

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

Bir Dönüştür Görevini Akışla

Bu uç nokta, Server-Sent Events (SSE) kullanarak bir dönüştür görevi için gerçek zamanlı güncellemeleri akış olarak iletir.

Parametreler

Name
id
Type
path
Description
Akış olarak iletilecek dönüştür görevi için benzersiz tanımlayıcı.

Döndürür

Server-Sent Events olarak Dönüştür Görevi Nesneleri akışı döndürür.

PENDING veya IN_PROGRESS görevleri için yanıt akışı yalnızca gerekli progress ve status alanlarını içerir.

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
}

Dönüştür Görevi Nesnesi

Dönüştür Görevi nesnesi bir format dönüştürme işini temsil eder.

Özellikler

id · string

Görev için benzersiz tanımlayıcı.

type · string

Görevin türü. Değer convert olur.

model_urls · object

Dönüştürülen model dosyaları için indirilebilir URL'ler. Yalnızca target_formats içinde belirtilen formatların URL'leri olur. Diğer format özellikleri boş dizeler olur.

progress · integer

Görevin progress değeri (0-100).

status · string

Görevin durumu. Olası değerler: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

preceding_tasks · integer

Önceki görevlerin sayısı. Yalnızca durum PENDING olduğunda anlamlıdır.

created_at · timestamp

Görevin oluşturulduğu zaman damgası, milisaniye cinsinden.

started_at · timestamp

Görevin başlatıldığı zaman damgası, milisaniye cinsinden. Başlatılmadıysa 0.

finished_at · timestamp

Görevin tamamlandığı zaman damgası, milisaniye cinsinden. Tamamlanmadıysa 0.

task_error · object

Görev başarısız olduysa hata nesnesi. Daha fazla ayrıntı için Hatalar bölümüne bakın.

consumed_credits · integer

Bu görev tarafından tüketilen kredi sayısı (dönüştürme görevi başına 1 kredi). FAILED görevler için 0 döndürür.