Creative Lab Anahtarlık API'si

Bir fotoğrafı, iki aşamada renkli kabartmalı, 3D baskıya uygun bir anahtarlığa dönüştürün. Bir prototip görevi, fotoğraftan renklendirilmiş bir konsept görüntü oluşturur. Bir build görevi, bu görüntüyü kabartmalı bir 3D modele dönüştürür ve prototip görevinin kimliğini input_task_id olarak alır.

POST /openapi/creative-lab/keychain/v1/prototype
POST /openapi/creative-lab/keychain/v1/build

POST/openapi/creative-lab/keychain/v1/prototype

Keychain prototip görevi oluştur

Bir fotoğraftan tek bir renklendirilmiş konsept görüntü oluşturur. 3D modeli oluşturmak için bu görevin ID'sini build uç noktasına input_task_id olarak iletin. Görevin alanları için Keychain prototip görev nesnesi bölümüne bakın.

Request

POST

/openapi/creative-lab/keychain/v1/prototype

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

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

Prototip örneği

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

Creative Lab Keychain girişi olarak kullanılan kaynak fotoğraf — Prototip girişi

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

Parametreler

Name
image_url
Type
string
Zorunlu
Description
Keychain konsept görüntüsüne dönüştürülecek fotoğraf; genel bir URL veya bir veri URI'si (data:image/jpeg;base64,<base64 ile kodlanmış görüntü verileriniz>) olarak.
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 en fazla 100 karakterlik bir ad. Bu ad, görevin name alanında geri döner. Daha uzun bir ad 400 döndürür.
Görevi kontrol panelinizde ve görev listelerinde etiketler; keychain üzerinde görünmez. Keychain üzerine bir ad koymak için name_text kullanın.
Name
name_text
Type
string
Description
Bir evcil hayvanın veya kişinin adı gibi, keychain'e eklenecek, en fazla 10 karakterlik bir ad. Meshy bayt değil karakter sayar, bu yüzden 10 karakterlik bir Çince, Japonca veya Korece ad sığar. Daha uzun bir ad 400 döndürür. Adsız bir keychain için bu alanı boş bırakın.
Ad, keychain'in yüzeyinde kabartma veya oyma metin olarak değil, düz renkli bir detay olarak görünür.
Meshy, çevredeki boşlukları kırpar ve görünmez biçimlendirme karakterlerini kaldırır. Prototip görev nesnesi sonucu name_text olarak döndürür, böylece build için ödeme yapmadan önce metni kontrol edebilirsiniz.
Meshy adı prototip aşamasında ekler. Build bunu korur ve build uç noktasına gönderilen bir name_text'i yok sayar.
Metin düz ASCII değilse, istek gövdesini Content-Type: application/json; charset=utf-8 ile UTF-8 olarak gönderin. Windows PowerShell'in Invoke-RestMethod'u gibi bazı HTTP istemcileri, gövdeyi varsayılan olarak ISO-8859-1 olarak kodlar. Bu, istek Meshy'ye ulaşmadan önce Latin olmayan her karakteri ? işaretine dönüştürür ve Meshy bunu göndermeyi amaçladığınız bir addan ayırt edemez.
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, tüm madalyonu koruyan şeffaf bir RGBA PNG döndürür, böylece onu herhangi bir arka plan üzerine yerleştirebilirsiniz. Build 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 ya da akışını izleyin. Ardından bu ID'yi build uç noktasına input_task_id olarak iletin.

Hata modları

Name
400 - Bad Request
Description
İstek çalıştırılamaz. Ö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.
- Veri URI'si geçerli base64 değil.
- name_text 10 karakterden uzun. Meshy bunu kısaltmak yerine reddeder ve istek için ücret talep etmez.
- Görüntü veya name_text, müstehcen (NSFW) olarak işaretlendi.
Hata mesajı hangi sorunu bulduğunu belirtir. İsteği düzeltin, sonra 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 sınırına ulaştı.
- Hesap ücretsiz plandadır.
Kredilerinizi ve planınızı kontrol edin, sonra tekrar deneyin.
Name
403 - Forbidden
Description
Ekibinizde IP Filtering açık ve Meshy görüntüyü üçüncü taraf fikri mülkiyeti nedeniyle işaretledi. Kullanma hakkına sahip olduğunuz bir görüntü gönderin. Meshy yalnızca görüntüyü fikri mülkiyet açısından kontrol eder, name_text'i değil.
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 bekleyin, sonra tekrar deneyin. Bkz. Hız sınırları.
- Görevlerinizin çok fazlası kuyrukta veya çalışıyor. Bazılarının tamamlanmasını bekleyin, sonra tekrar deneyin.
- Kredisi kalmamış sınırsız bir planda, kredisiz çalışabilecek görev sayısına ulaştınız. Bir görevin tamamlanmasını 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 tahsil ettiği tüm kredileri iade eder. İsteği tekrar deneyin.

POST/openapi/creative-lab/keychain/v1/build

Keychain build görevi oluştur

Başarılı bir prototip görevinden 3D baskıya uygun anahtarlık oluşturur. Meshy, prototipin kavram görselini bir derinlik haritası kabartmasına dönüştürür ve seçtiğiniz formatta tek bir model dosyası döndürür. Görevin alanları için bkz. Keychain build görev nesnesi.

Request

POST

/openapi/creative-lab/keychain/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Build example

The build task converts the selected prototype image into a 3D-printable keychain model.

Creative Lab Keychain 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/keychain/v1/prototype ile oluşturduğu ve durumu SUCCEEDED olan bir görev olmalıdır.
API'den gelen Keychain prototip görevlerinizden biri olmayan bir kimlik, web uygulamasında oluşturulmuş bir prototip dahil, 404 döndürür.
Name
name
Type
string
Description
Görev için en fazla 100 karakterlik bir ad. Görevin name alanında geri döner. Daha uzun bir ad 400 döndürür.

`options`

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

Name
badge_shape
Type
string
varsayılan circle
Description
Meshy, dış hattı konudan izlemediğinde anahtarlığın dış hattı. Meshy bunu remove_background 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 40
Description
Anahtarlığı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 2.2
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 0.1
Description
Kabartmanın arkasındaki düz taban plakasının kalınlığı, milimetre cinsinden, 0 ile 20 arasında.
Name
has_closed_back
Type
boolean
varsayılan true
Description
Anahtarlığın arkasını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 tersine ç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
Kabartmanın ve dokusunun dış hat içinde, 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 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
Anahtarlığın dış hattının konudan izlenip izlenmeyeceği, böylece anahtarlık 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örüntüsünün saydam bir arka plana sahip olup olmadığı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ğ, ayrıntı eklemeden yüzey ekler. 0 varsayılanı kullanır.

`output`

İsteğe bağlı. Build işleminin döndürdüğü dosya formatını ayarlar.

Name
format
Type
string
varsayılan glb
Description
Build işleminin 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 build görevinin kimliğini tutar. status SUCCEEDED olana kadar görevi alın veya akışını izleyin. Ardından model_urls içindeki tek girişten dosyayı 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ı kendi aralığının dışında veya kullanılabilir bir değer değil.
Hata mesajı hangi sorunu bulduğunu belirtir.
Name
401 - Unauthorized
Description
API anahtarı eksik veya geçersiz. Authorization başlığını kontrol edin.
Name
402 - Payment Required
Description
Şunlardan 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 edip tekrar deneyin.
Name
404 - Not Found
Description
input_task_id, hesabınızın API ile oluşturduğu herhangi bir Keychain prototip görevi ile eşleşmiyor. Web uygulamasında oluşturulmuş 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
Şu 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ı.
- Sırada bekleyen veya çalışan göreviniz çok fazla. Bazılarının bitmesini bekleyip tekrar deneyin.
- Kredisi kalmamış sınırsız bir plandaysanız, kredi olmadan çalışabilecek görev sayısına ulaştınız. Bir görevin bitmesini bekleyin veya kredi ekleyin.

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

Bir Keychain 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. Keychain prototype görev nesnesi ve Keychain build görev nesnesi.

Request

GET

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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.

Hata modları

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
Takımınızda IP Filtering açık ve Meshy, prototype görevinin görselini üçüncü taraf fikri mülkiyet açısından işaretledi. Build görevleri ve Enterprise planındaki takımlar bu hatayı almaz. Kullanma haklarına sahip olduğunuz bir görselden prototype görevi oluşturun.
Name
404 - Not Found
Description
Bu ID'ye sahip hiçbir Keychain görevi hesabınıza ait değil veya görevin aşaması yol ile eşleşmiyor. ID'yi kontrol edin ve göreve uygun olarak /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/keychain/v1/(prototype|build)/:id

Bir Keychain görevini sil

Bir Keychain görevini iptal eder. PENDING durumundaki bir görevi iptal etmek, kredilerini iade eder. IN_PROGRESS durumundaki bir görev, bir worker tarafından zaten başlatıldığı için iadesiz olarak 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, bir build görevinin ID'si ile /prototype/:id üzerinde DELETE çağrısı yapmak 404 döndürür.

Request

DELETE

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -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 nedenle iptal edilemez.
Name
404 - Not Found
Description
Bu ID'ye sahip hiçbir Keychain görevi hesabınıza ait değil veya görevin aşaması yolla eşleşmiyor. ID'yi kontrol edin ve göreve uygun olarak /prototype veya /build kullanın.

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

Bir Keychain görevini akışla izleyin

Bir Keychain görevinin güncellemelerini Sunucu Gönderimli Olaylar (SSE) olarak akışa aktarır. Yol, görevin aşamasıyla eşleşmelidir. Eşleşmezse, örneğin bir build görevinin ID'si /prototype/:id/stream adresinde kullanılırsa, akış status_code: 404 ile bir error olayı gönderir ve kapanır.

Request

GET

/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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

prototype veya build görev nesnelerinden oluşan bir akış. Her olay, Bir Keychain görevini alın tarafından döndürüldüğü şekliyle 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.

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

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

Keychain görevlerini listele

Tek bir aşamaya ait Keychain görevlerinizi, seferde bir sayfa olacak şekilde döndürür. Yol (path), aşamayı seçer. /prototype yalnızca prototip görevlerini, /build ise yalnızca build görevlerini döndürür.

Request

GET

/openapi/creative-lab/keychain/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "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ışında 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ışında 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şamaya uygun olarak, prototip görev nesneleri veya build görev nesneleri dizisi.

Keychain prototype görev nesnesi

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

Özellikler

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "name_text": "Luna",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "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. Biçimine güvenmeyin.
Name
type
Type
string
Description
Görev türü, her zaman creative-lab-keychain-prototype.
Name
name
Type
string
Description
Görevi oluştururken gönderdiğiniz name değeri, veya göndermediyseniz "".
Name
name_text
Type
string
Description
Meshy'nin, boşlukları kırptıktan ve görünmez biçimlendirme karakterlerini kaldırdıktan sonra anahtarlığa eklediği isim. name_text göndermediyseniz bu alan bulunmaz. HTTP istemcinizin metni doğru kodladığından emin olmak için, gönderdiğiniz değerle karşılaştırın.
Name
status
Type
string
Description
Görevin durumu.
Olası değerler:
- PENDING: sırada bekliyor
- IN_PROGRESS: sonuç üretiliyor
- SUCCEEDED: nihai, sonuçla birlikte
- FAILED: nihai, nedeni task_error içinde
- CANCELED: nihai, 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 süresinin dolduğu zaman, Unix milisaniye cinsinden. Bu, finished_at'ten 3 gün sonra, görev bitene kadar ise created_at'ten 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örev PENDING durumundayken sıradaki konumu. 1, görevin sırada bir sonraki olduğu anlamına gelir. Görev sıradan çıktıktan sonra 0'dır ve liste sonuçlarında 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
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 ü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 yeniden deneyin.
Name
image_urls
Type
array of strings
Description
Konsept görüntüsü için indirme URL'leri. Görev başarılı olduktan sonra dizi bir URL içerir, o zamana kadar boştur.

Anahtarlık oluşturma görevi nesnesi

Bir oluşturma görevi, başarılı olan bir prototip görevinden 3D anahtarlığı üretir. İstediğiniz formatta bir model dosyası döndürür.

Özellikler

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
Görev kimliği. Biçimine güvenmeyin.
Name
type
Type
string
Description
Görev türü, her zaman creative-lab-keychain-build.
Name
name
Type
string
Description
Görevi oluştururken gönderdiğiniz name değeri, göndermediyseniz "".
Name
status
Type
string
Description
Görevin durumu.
Kullanılabilir değerler:
- PENDING: sırada bekliyor
- IN_PROGRESS: sonuç üretiliyor
- SUCCEEDED: nihai, sonuç ile birlikte
- FAILED: nihai, nedeni task_error içinde
- CANCELED: nihai, sonuç yok
Name
progress
Type
integer
Description
Yapılan 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öreve başladığı 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 süresinin dolduğu zaman, Unix milisaniye cinsinden. Bu, finished_at'ten 3 gün sonrası, ya da görev tamamlanana kadar created_at'ten 3 gün sonrasıdır. API sonuçlarını süresiz olarak saklayan Enterprise hesaplar için bu, yaklaşık 100 yıl sonrasıdır. Bkz. Varlık saklama.
Name
preceding_tasks
Type
integer
Description
Görevin PENDING durumundayken sıradaki konumu. 1, bir sonraki sırada başlayacağı anlamına gelir. Görev sıradan çı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 olan bir görev 0'dır, çünkü Meshy bunu iade eder. İptal etme, bir görevi yalnızca PENDING durumundayken iade eder. Meshy ücreti okuyamazsa, bir get ya da 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
model_urls
Type
object
Description
Model dosyası için indirme URL'leri; istediğiniz output.format için bir girdi bulunur. 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 dosyalarını 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.