Dönüştür API

Dönüştür API, mevcut 3D modelleri farklı dosya formatlarına dönüştürmenize olanak tanır.

POST/openapi/v1/convert

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

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

Yol Parametreleri

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

Görev Durumu

Hâlâ PENDING durumunda olan bir görev silinir ve oluşturma sırasında harcanan krediler iade edilir.

Zaten IN_PROGRESS durumunda olan bir görev silinemez: istek 409 Conflict ile reddedilir ve görev çalışmaya devam eder. Worker'ın zaten başlattığı bir görev için krediler iade edilemez, bu nedenle görevi çalışma sırasında silmek hem kredilerinize hem de sonuca mal olur. Görevin SUCCEEDED, FAILED veya CANCELED durumuna ulaşmasını bekleyin, ardından silin.

Sonlanmış bir durumdaki (SUCCEEDED, FAILED veya CANCELED) bir görev iade yapılmadan silinir.

Dönüş Değerleri

Başarılı olduğunda 200 OK, görev IN_PROGRESS durumundayken ise 409 Conflict döner.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/convert

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

Bu uç nokta, dönüştürme görevlerinin bir 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 100 öğedir.

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

Dönüş Değerleri

Sayfalanmış bir Dönüştürme 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

Dönüştürme Görevini Akışa Al (Stream)

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

Parametreler

Name
id
Type
path
Description
Akışa alınacak dönüştürme görevi için benzersiz tanımlayıcı.

Dönüş Değerleri

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

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

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
}

Convert Task Nesnesi

Convert Task 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 şeklindedir.

model_urls · object

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

progress · integer

Görevin ilerlemesi (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şladığı zaman damgası, milisaniye cinsinden. Başlamadıysa 0.

finished_at · timestamp

Görevin bittiği zaman damgası, milisaniye cinsinden. Bitmediyse 0.

task_error · object

Görev başarısız olursa hata nesnesi. Daha fazla ayrıntı için Hatalar sayfasına bakın.

consumed_credits · integer

Bu görev tarafından tüketilen kredi sayısı (her convert görevi için 1 kredi). FAILED görevler için 0 döner.

Dönüştür API

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

Parametreler

Dönüş Değerleri

Hata Modları

Request

Response

Bir Dönüştürme Görevini Getir

Parametreler

Dönüş Değerleri

Request

Response

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

Yol Parametreleri

Görev Durumu

Dönüş Değerleri

Request

Response

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

Parametreler

Dönüş Değerleri

Request

Response

Dönüştürme Görevini Akışa Al (Stream)

Parametreler

Dönüş Değerleri

Request

Response Stream

Convert Task Nesnesi

Özellikler