Creative Lab Buzdolabı Mıknatısı API

Bir fotoğrafı, renkli kabartma ve düz arka yüzeye sahip, 3D baskıya uygun bir buzdolabı mıknatısına iki aşamada dönüştürün. Bir prototip görevi, fotoğraftan renklendirilmiş bir kavram görseli oluşturur. Bir build görevi ise bu görseli bir kabartma 3D modele dönüştürür ve prototip görevinin kimliğini input_task_id olarak alır.

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

Bir Fridge Magnet prototip görevi oluşturma

Bir fotoğraftan renklendirilmiş bir konsept görüntüsü oluşturur. 3D modeli oluşturmak için bu görevin ID'sini input_task_id olarak build uç noktasına iletin. Görevin alanları için bkz. Fridge Magnet prototip görevi nesnesi.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/prototype

# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

{
  "result": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}

Prototip örneği

Bir kaynak fotoğrafla başlayın, ardından buzdolabı mıknatısı build aşaması tarafından kullanılan prototip görüntüyü oluşturun.

Creative Lab Fridge Magnet girdisi olarak kullanılan kaynak manzara fotoğrafı — Prototip girdisi

Kaynak fotoğraftan oluşturulan Creative Lab Fridge Magnet prototip çıktısı — Prototip çıktısı

Parametreler

Name
image_url
Type
string
Zorunlu
Description
Buzdolabı mıknatısı konsept görüntüsüne dönüştürülecek fotoğraf; herkese açık bir URL veya bir data URI olarak (data:image/jpeg;base64,<base64 ile kodlanmış görüntü verileriniz>).
Görüntü en fazla 20 MB boyutunda bir JPG, JPEG, PNG veya WebP dosyası olmalıdır.
Name
name
Type
string
Description
Görev için bir ad, en fazla 100 karakter. Görevin name alanında geri döner. Daha uzun bir ad 400 döndürür.
Name
remove_background
Type
boolean
varsayılan false
Description
Prototip görüntüsünden arka planın kaldırılıp kaldırılmayacağı. true, mıknatısın tamamını koruyan şeffaf bir RGBA PNG döndürür, böylece onu istediğiniz herhangi bir arka plana yerleştirebilirsiniz. Build işlemi de arka planı olmayan görüntüden başlar. Meshy arka planı kaldıramazsa, görüntüyü arka planıyla birlikte döndürür ve görev yine de başarılı olur.
Build'in remove_background seçeneği ayrıdır.

Dönüş Değerleri

result alanı yeni prototip görevinin ID'sini tutar. status değeri SUCCEEDED olana kadar görevi alın veya akış olarak izleyin. Ardından ID'yi input_task_id olarak build uç noktasına iletin.

Hata modları

Name
400 - Bad Request
Description
İstek çalıştırılamıyor. Örneğin:
- image_url eksik.
- Görüntü bir JPG, JPEG, PNG veya WebP dosyası değil.
- Görüntü çok küçük, 20 MB'ın üzerinde veya maksimum piksel sayısının üzerinde.
- Meshy görüntüyü indiremiyor, örneğin URL 404 döndürdüğü veya zaman aşımına uğradığı için.
- Data URI geçerli bir base64 değil.
- Görüntü NSFW olarak işaretlendi.
Hata mesajı hangi sorunu bulduğunu belirtir. İsteği düzeltin, ardından tekrar gönderin.
Name
401 - Unauthorized
Description
API anahtarı eksik veya geçersiz. Authorization başlığını kontrol edin.
Name
402 - Payment Required
Description
Aşağıdakilerden biri geçerlidir:
- Hesapta yeterli kredi yok.
- API anahtarı, çalışma alanı veya üye kredi limitine ulaştı.
- Hesap ücretsiz plandadır.
Kredilerinizi ve planınızı kontrol edin, ardından tekrar deneyin.
Name
403 - Forbidden
Description
Ekibinizde IP Filtering özelliği açık ve Meshy, görüntüyü üçüncü taraf fikri mülkiyeti nedeniyle işaretledi. Kullanım hakkına sahip olduğunuz bir görüntü gönderin.
Name
429 - Too Many Requests
Description
Aşağıdaki sınırlardan biri aşıldı:
- Hız sınırınızın izin verdiğinden daha fazla istek gönderdiniz. Birkaç saniye bekleyin, ardından tekrar deneyin. Bkz. Hız sınırları.
- Sıraya alınmış veya çalışan görevleriniz çok fazla. Bazılarının bitmesini bekleyin, ardından tekrar deneyin.
- Kredi kalmayan sınırsız bir planda, kredisiz çalıştırılabilecek görev sayısına ulaştınız. Bir görevin bitmesini bekleyin veya kredi ekleyin.
Name
500 - Internal Server Error
Description
Meshy bir sunucu hatasıyla karşılaştı, örneğin görüntü üzerinde fikri mülkiyet kontrolünü çalıştıramadığı için. Meshy görevi oluşturmaz ve varsa tahsil ettiği kredileri iade eder. İsteği tekrar deneyin.

POST/openapi/creative-lab/fridge-magnet/v1/build

Fridge Magnet oluşturma görevi oluştur

Başarılı bir prototip görevinden 3B baskıya uygun buzdolabı mıknatısı oluşturur. Meshy, prototipin konsept görselini bir derinlik haritası kabartmasına dönüştürür ve seçtiğiniz formatta bir model dosyası döndürür. Görevin alanları için bkz. Fridge Magnet oluşturma görevi nesnesi.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}

Build example

The build task turns the selected prototype image into a 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

Parametreler

Name
input_task_id
Type
string
Zorunlu
Description
Oluşturulacak prototip görevinin kimliği. Bu, hesabınızın POST /openapi/creative-lab/fridge-magnet/v1/prototype ile oluşturduğu ve durumu SUCCEEDED olan bir görev olmalıdır.
API üzerinden oluşturduğunuz Fridge Magnet prototip görevlerinizden biri olmayan bir kimlik 404 döndürür; web uygulamasında oluşturulan bir prototip de buna dahildir.
Name
name
Type
string
Description
Görev için en fazla 100 karakter uzunluğunda bir isim. Bu isim, görevin name alanında geri döner. Daha uzun bir isim 400 döndürür.

`options`

Kabartmanın şekli için isteğe bağlı ayarlar. Her alanın bir varsayılan değeri vardır, bu yüzden yalnızca değiştirmek istediğiniz alanları gönderin. Bir alanın aralığı dışındaki bir değer 400 döndürür.

Name
badge_shape
Type
string
varsayılan rounded-rect
Description
Meshy, konunun dış hattını izlemediğinde mıknatısın dış hattı. Meshy bunu remove_background değeri false olduğunda veya konunun dış hattını bulamadığında kullanır.
Kullanılabilir değerler:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
varsayılan 60
Description
Mıknatısın sınırlayıcı karesinin kenar uzunluğu, milimetre cinsinden, en fazla 400. 0 varsayılanı kullanır.
Name
relief_height_mm
Type
number
varsayılan 3.3
Description
Kabartmanın taban üzerindeki maksimum yüksekliği, milimetre cinsinden, 0 ile 20 arasında.
Name
relief_offset_mm
Type
number
varsayılan 0
Description
Kabartmanın ne kadar alçaltılacağı, milimetre cinsinden, 0 ile 20 arasında. Meshy bunu kabartmanın yüksekliğinden her yerde, tabana kadar çıkarır.
Name
base_thickness_mm
Type
number
varsayılan 2.0
Description
Kabartmanın arkasındaki düz taban plakasının kalınlığı, milimetre cinsinden, 0 ile 20 arasında. Varsayılan 2 mm'lik taban, mıknatısa buzdolabına tutunacak yeterli gövdeyi verir, böylece kabartma kırılgan hissettirmez.
Name
has_closed_back
Type
boolean
varsayılan true
Description
Mıknatısın arkasının, yani mıknatısı yapıştırdığınız tarafın kapatılıp kapatılmayacağı. false, arkayı bir kabuk gibi açık bırakır.
Name
relief_curve
Type
string
varsayılan linear
Description
Derinlik haritası değerlerini kabartma yüksekliğine eşleyen eğri.
Kullanılabilir değerler:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
varsayılan 1.0
Description
Eğrinin gücü, en fazla 10. gamma ve s-curve eğrileri bunu kullanır, linear ise yok sayar. 0 varsayılanı kullanır.
Name
invert_depth
Type
boolean
varsayılan false
Description
Derinlik haritasının ters çevrilip çevrilmeyeceği, böylece daha koyu alanlar daha yüksek kabartma haline gelir.
Name
smoothing
Type
number
varsayılan 0.24
Description
Meshy kabartmayı oluşturmadan önce derinlik haritasının ne kadar yumuşatılacağı, 0 ile 10 arasında.
Name
relief_scale
Type
number
varsayılan 1.0
Description
Dış hat içinde kabartmanın ve dokusunun merkez etrafında ne kadar yakınlaştırılacağı, en fazla 10. 1'in üzerindeki bir değer konuyu büyütür, 1'in altındaki bir değer ise küçültür. Kabartmanın yüksekliğini değiştirmez. 0 varsayılanı kullanır.
Name
depth_threshold
Type
number
varsayılan 0.1
Description
Meshy'nin derinliği sıfıra ayarladığı derinlik haritası değeri eşiği, 0 ile 1 arasında.
Name
remove_background
Type
boolean
varsayılan true
Description
Mıknatısın dış hattının konudan izlenip izlenmeyeceği, böylece mıknatıs konunun şeklini takip eder. false, bunun yerine badge_shape dış hattını kullanır. Meshy, konunun dış hattını bulamadığında da badge_shape kullanır.
Bu, prototipin görselinin saydam bir arka plana sahip olup olmayacağını belirleyen prototipin remove_background parametresinden ayrıdır.
Name
export_resolution
Type
integer
varsayılan 512
Description
Dışa aktarılan modelin ağ çözünürlüğü, 64 ile 512 arasında. Meshy, geometriyi 512 piksellik bir derinlik haritasından oluşturur, bu yüzden daha ince bir ağ detay eklemeden yüz sayısını artırır. 0 varsayılanı kullanır.

`output`

İsteğe bağlı. Oluşturma görevinin döndüreceği dosya formatını ayarlar.

Name
format
Type
string
varsayılan glb
Description
Oluşturma görevinin döndürdüğü dosya formatı.
Kullanılabilir değerler:
- glb: model_urls.glb içinde tek bir model.glb dosyası
- obj: model_urls.obj içinde model.obj, model.mtl ve texture.png içeren bir zip dosyası
- zip: model_urls.bundle_zip içinde Meshy'nin oluşturduğu her dosyayı içeren bir zip dosyası

Dönüş Değerleri

result alanı, yeni oluşturma görevinin kimliğini tutar. status değeri SUCCEEDED olana kadar görevi alın ya da akışını izleyin. Ardından dosyayı model_urls içindeki tek girişten indirin.

Hata modları

Name
400 - Bad Request
Description
İstek çalıştırılamıyor. Örneğin:
- input_task_id eksik veya geçerli bir görev kimliği değil.
- Prototip görevinin durumu SUCCEEDED değil. Hâlâ çalışıyorsa bekleyin ve tekrar deneyin. Başarısız olduysa veya iptal edildiyse yeni bir prototip görevi oluşturun.
- Prototip görevi başarılı oldu ancak görseli yok. Yeni bir prototip görevi oluşturun.
- Bir options alanı aralığının dışında veya kullanılabilir bir değer değil.
Hata mesajı hangi sorunun bulunduğunu belirtir.
Name
401 - Unauthorized
Description
API anahtarı eksik veya geçersiz. Authorization başlığını kontrol edin.
Name
402 - Payment Required
Description
Bunlardan biri geçerlidir:
- Hesapta yeterli kredi yok.
- API anahtarı, çalışma alanı veya üye kredi limitine ulaştı.
- Hesap ücretsiz plandadır.
Kredilerinizi ve planınızı kontrol edin, ardından tekrar deneyin.
Name
404 - Not Found
Description
input_task_id, hesabınızın API ile oluşturduğu herhangi bir Fridge Magnet prototip göreviyle eşleşmiyor. Web uygulamasında oluşturulan bir prototip de 404 döndürür. Bir prototip oluşturma yanıtından gelen result kimliğini gönderin.
Name
429 - Too Many Requests
Description
Bu sınırlardan biri aşıldı:
- Hız sınırınızın izin verdiğinden daha fazla istek gönderdiniz. Birkaç saniye bekleyip tekrar deneyin. Bkz. Hız sınırları.
- Görevlerinizden çok fazlası sırada bekliyor veya çalışıyor. Bazılarının bitmesini bekleyip tekrar deneyin.
- Kredisi kalmamış sınırsız bir planda, kredisiz çalıştırılabilecek görev sayısına ulaştınız. Bir görevin bitmesini bekleyin veya kredi ekleyin.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Bir buzdolabı mıknatısı görevini al

Bir prototype veya build görevini döndürür. Yol, görevin aşamasıyla eşleşmelidir. /prototype/:id üzerinden istenen bir build görevi 404 döndürür, /build/:id üzerinden istenen bir prototype görevi de aynı şekilde 404 döndürür.

Alanlar için bkz. Buzdolabı mıknatısı prototype görev nesnesi ve Buzdolabı mıknatısı build görev nesnesi.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametreler

Name
id
Type
path
Description
Oluşturma yanıtından alınan görev ID'si.

Dönüş değerleri

Yoldaki aşamayla eşleşen prototype görev nesnesi veya build görev nesnesi.

Başarısızlık durumları

Name
400 - Bad Request
Description
id geçerli bir görev ID'si değil. Oluşturma yanıtındaki result ID'sini gönderin.
Name
403 - Forbidden
Description
Ekibinizde IP Filtering açık ve Meshy, prototype görevinin görselini üçüncü taraf fikri mülkiyeti ile işaretledi. Build görevleri ve Enterprise planındaki ekipler bu hatayı almaz. Kullanım haklarına sahip olduğunuz bir görselden prototype görevi oluşturun.
Name
404 - Not Found
Description
Bu ID'ye sahip bir buzdolabı mıknatısı görevi hesabınıza ait değil veya görevin aşaması yolla eşleşmiyor. ID'yi kontrol edin ve görevle eşleşmesi için /prototype veya /build kullanın.
Name
500 - Internal Server Error
Description
Meshy fikri mülkiyet kontrolünü çalıştıramadı. İsteği yeniden deneyin.

DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Bir buzdolabı mıknatısı görevini sil

Bir buzdolabı mıknatısı görevini iptal eder. PENDING durumundaki bir görevi iptal etmek, kredilerini iade eder. IN_PROGRESS durumundaki bir görev, bir çalışan zaten göreve başladığı için iade yapılmadan iptal edilir. Nihai durumda olan bir görev (SUCCEEDED, FAILED veya CANCELED) iptal edilemez.

Yol, görevin aşamasıyla eşleşmelidir. Örneğin, /prototype/:id üzerinde bir derleme (build) görevinin ID'si ile yapılan DELETE işlemi 404 döndürür.

Request

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Yol parametreleri

Name
id
Type
path
Description
İptal edilecek görevin ID'si.

Dönüş değerleri

Boş gövdeyle birlikte 204 No Content.

Hata durumları

Name
400 - Bad Request
Description
Aşağıdakilerden biri geçerlidir:
- id geçerli bir görev ID'si değil. Oluşturma yanıtındaki result ID'sini gönderin.
- Görev zaten nihai bir duruma sahip (SUCCEEDED, FAILED veya CANCELED), bu yüzden iptal edilemez.
Name
404 - Not Found
Description
Bu ID'ye sahip hesabınıza ait bir buzdolabı mıknatısı görevi yok veya görevin aşaması yol ile eşleşmiyor. ID'yi kontrol edin ve görevle eşleşmesi için /prototype veya /build kullanın.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

Fridge Magnet görevini akışla alma

Bir Fridge Magnet görevinin güncellemelerini Server-Sent Events (SSE) olarak akışla iletir. Yol, görevin aşamasıyla eşleşmelidir. Eşleşmezse — örneğin bir build görevinin ID'si /prototype/:id/stream adresine verildiğinde — akış, status_code: 404 ile tek bir error olayı gönderir ve kapanır.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametreler

Name
id
Type
path
Description
Oluşturma yanıtından gelen görev ID'si.

Dönüş Değerleri

prototype veya build görev nesnelerinin bir akışı. Her olay, Fridge Magnet görevini al işleminin döndürdüğü haliyle tam görev nesnesini içerir. Görev PENDING veya IN_PROGRESS durumundayken çıktı alanları hâlâ boştur (null, [] veya {}) ve finished_at değeri null'dur.

Eğer IP Filtreleme görevin sonucunu engellerse, akış bunun yerine bir get isteğinin döndüreceği status_code ile tek bir error olayı gönderir.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

Fridge Magnet görevlerini listele

Bir aşamaya ait Fridge Magnet görevlerinizi, her seferinde bir sayfa olmak üzere döndürür. Yol (path) aşamayı belirler. /prototype yalnızca prototip görevlerini, /build ise yalnızca derleme (build) görevlerini döndürür.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Yol parametreleri

Name
stage
Type
path
Zorunlu
Description
Listelenecek aşama, prototype veya build.

Sorgu parametreleri

Name
page_num
Type
integer
varsayılan 1
Description
Döndürülecek sayfa, 1 ile 255 arasında. 0 ilk sayfayı döndürür. 0 ile 255 dışındaki bir değer 400 döndürür.
Name
page_size
Type
integer
varsayılan 10
Description
Sayfa başına görev sayısı, en fazla 100. 101 ile 255 arasındaki bir değer 100 görev döndürür ve 0 varsayılanı kullanır. 0 ile 255 dışındaki bir değer 400 döndürür.
Name
sort_by
Type
string
varsayılan -created_at
Description
Sıralama düzeni.
Kullanılabilir değerler:
- -created_at: önce en yeni
- +created_at: önce en eski

Dönen değerler

Yoldaki aşamayla eşleşen, prototip görev nesneleri veya derleme görev nesneleri içeren bir dizi.

Fridge Magnet prototype görev nesnesi

Bir prototip görevi, bir fotoğraftan renklendirilmiş bir konsept görseli oluşturur. Görseli bir 3D modele dönüştürmek için görevin ID'sini input_task_id olarak build uç noktasına iletin.

Özellikler

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
Görev ID'si. Formatına güvenmeyin.
Name
type
Type
string
Description
Görev türü, her zaman creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Görevi oluşturduğunuzda gönderdiğiniz name değeri, göndermediyseniz "".
Name
status
Type
string
Description
Görevin durumu.
Kullanılabilir değerler:
- PENDING: kuyrukta bekliyor
- IN_PROGRESS: sonuç oluşturuluyor
- SUCCEEDED: tamamlandı, sonuçla birlikte
- FAILED: tamamlandı, nedeni task_error içinde
- CANCELED: tamamlandı, sonuç yok
Name
progress
Type
integer
Description
Tamamlanan işin yüzdesi, 0 ile 100 arasında. Görev başlayana kadar 0, başarılı olduğunda 100 olur.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zaman, Unix milisaniye cinsinden.
Name
started_at
Type
timestamp
Description
Bir işçinin görevi başlattığı zaman, Unix milisaniye cinsinden. O zamana kadar null.
Name
finished_at
Type
timestamp
Description
Görevin nihai duruma ulaştığı zaman, Unix milisaniye cinsinden. O zamana kadar null.
Name
expires_at
Type
timestamp
Description
Görevin sonucunun sona erdiği zaman, Unix milisaniye cinsinden. Bu, finished_at'tan 3 gün sonrası ya da görev tamamlanana kadar created_at'tan 3 gün sonrasıdır. API sonuçlarını süresiz olarak saklayan Enterprise hesaplar için bu süre yaklaşık 100 yıl sonrasıdır. Bkz. Varlık saklama.
Name
preceding_tasks
Type
integer
Description
Görevin PENDING durumundayken kuyruktaki konumu. 1, bir sonraki sırada başlayacağı anlamına gelir. Görev kuyruktan çıktıktan sonra 0, liste sonuçlarında ise her zaman 0.
Name
task_error
Type
object
Description
Görevin neden başarısız olduğu. status değeri FAILED olmadıkça null. Bkz. Hatalar.
Name
consumed_credits
Type
integer
Description
Herhangi bir iade sonrasında görev için tahsil edilen kredi sayısı. Hata döndüren bir istekten ücret alınmaz. Başarısız bir görev 0'dır, çünkü Meshy bunu iade eder. İptal etme, yalnızca görev PENDING durumundayken bir görevi iade eder. Meshy tahsilatı okuyamazsa, bir get veya stream yanıtı bu alanı dışarıda bırakır ve bir liste isteği 500 döndürür. Bu durumda isteği yeniden deneyin.
Name
image_urls
Type
array of strings
Description
Konsept görseli için indirme URL'leri. Görev başarılı olduktan sonra dizide bir URL bulunur, o zamana kadar boştur.

Buzdolabı mıknatısı yapım görevi (build task) nesnesi

Bir yapım görevi, başarılı olmuş bir prototip görevinden 3D buzdolabı mıknatısı üretir. Talep ettiğiniz formatta tek bir model dosyası döndürür.

Özellikler

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
Görev ID'si. Formatına güvenmeyin.
Name
type
Type
string
Description
Görev türü, her zaman creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
Görevi oluştururken gönderdiğiniz name, göndermediyseniz "".
Name
status
Type
string
Description
Görevin durumu.
Kullanılabilir değerler:
- PENDING: kuyrukta bekliyor
- IN_PROGRESS: sonuç oluşturuluyor
- SUCCEEDED: son durum, sonuçla birlikte
- FAILED: son durum, nedeni task_error içinde
- CANCELED: son durum, sonuç yok
Name
progress
Type
integer
Description
Tamamlanan işin yüzdesi, 0 ile 100 arası. Görev başlayana kadar 0, başarılı olduğunda 100'dür.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zaman, Unix milisaniye cinsinden.
Name
started_at
Type
timestamp
Description
Bir işçinin (worker) görevi başlattığı zaman, Unix milisaniye cinsinden. O ana kadar null.
Name
finished_at
Type
timestamp
Description
Görevin son bir duruma ulaştığı zaman, Unix milisaniye cinsinden. O ana kadar null.
Name
expires_at
Type
timestamp
Description
Görevin sonucunun süresinin dolduğu zaman, Unix milisaniye cinsinden. finished_at'ten 3 gün sonra, görev tamamlanana kadar ise created_at'ten 3 gün sonradır. API sonuçlarını süresiz olarak saklayan Enterprise hesaplar için bu süre yaklaşık 100 yıl sonradır. Bkz. Varlık saklama.
Name
preceding_tasks
Type
integer
Description
Görev PENDING durumundayken kuyruktaki konumu. 1, sıradaki görev olduğu anlamına gelir. Görev kuyruktan ayrıldıktan sonra 0, liste sonuçlarında ise her zaman 0'dır.
Name
task_error
Type
object
Description
Görevin neden başarısız olduğu. status değeri FAILED olmadıkça null. Bkz. Hatalar.
Name
consumed_credits
Type
integer
Description
Görev için, varsa iade sonrası tahsil edilen kredi sayısı. Hata döndüren bir istekten ücret alınmaz. Başarısız bir görev 0'dır, çünkü Meshy bunu iade eder. İptal etme, yalnızca görev PENDING durumundayken ücreti iade eder. Meshy ücreti okuyamazsa, bir get veya stream yanıtı bu alanı dışarıda bırakır ve bir liste isteği 500 döndürür. Bu durumda isteği tekrar deneyin.
Name
model_urls
Type
object
Description
Model dosyası için indirme URL'leri; talep ettiğiniz output.format için bir giriş içerir. Görev başarılı olana kadar {}.
- Name
  glb
  Type
  string
  Description
  GLB dosyası için indirme URL'si. output.format değeri glb olduğunda bulunur.
- Name
  obj
  Type
  string
  Description
  model.obj, model.mtl ve texture.png içeren bir zip dosyası için indirme URL'si. output.format değeri obj olduğunda bulunur.
- Name
  bundle_zip
  Type
  string
  Description
  Meshy'nin ürettiği tüm dosyaları içeren bir zip dosyası için indirme URL'si. output.format değeri zip olduğunda bulunur.