Metinden 3D'ye API

Metinden 3D'ye API, Meshy'nin Metinden 3D'ye yeteneklerini kendi uygulamanıza entegre etmenizi sağlayan bir özelliktir. Bu bölümde bu API ile başlamanız için gereken tüm bilgileri bulacaksınız.

Metinden 3D'ye iki adımlı bir iş akışını kullanır. İlk önce, bir önizleme görevi (mode: "preview") oluşturun, bu sayede doku olmadan bir 3D ağ üretebilir ve şekli değerlendirebilirsiniz. Ardından, tamamlanan önizlemenin görev kimliğini bir iyileştirme görevine (mode: "refine") geçirerek ağa doku uygulayın. Her iki adım da aynı uç noktayı paylaşır.

POST/openapi/v2/text-to-3d

Bir Metinden 3D Önizleme Görevi Oluştur

Bu uç nokta, bir Metinden 3D önizleme görevi oluşturur ve bu, bir metin promptundan dokusuz (yalnızca geometri) bir 3D ağ üretir. İki aşamalı iş akışının ilk adımıdır. Önbellek başarıya ulaştığında, doku için bir iyileştirme görevi oluşturmak için döndürülen görev kimliğini kullanın. Tam yanıt şeması için Metinden 3D'ye Görev Nesnesi bölümüne başvurun.

Parametreler

Name
mode
Type
string
Zorunlu
Description
Bir önizleme görevi oluştururken bu alan "preview" olarak ayarlanmalıdır.
Name
prompt
Type
string
Zorunlu
Description
3D modelin ne tür bir nesne olduğunu tanımlayın. Maksimum 600 karakter.
Name
model_type
Type
string
varsayılan standard
Description
3D ağ oluşturma türünü belirtin.
Mevcut değerler:
- standard: Normal yüksek detaylı 3D ağ oluşturma.
- smart-topology: ai_model (meshy-t2) ile birlikte Smart Topology modelini seçin.
- lowpoly (kullanımdan kaldırıldı): Temiz poligonlar için optimize edilmiş low-poly ağ üretir. Bunun yerine smart-topology kullanmanızı öneriyoruz.
smart-topology seçildiğinde, should_remesh ve decimation_mode göz ardı edilir ve yalnızca topology: triangle kabul edilir.
lowpoly seçildiğinde, ai_model, topology, target_polycount ve should_remesh göz ardı edilir.
Name
ai_model
Type
string
varsayılan latest
Description
Kullanılacak modelin kimliği. Mevcut değerler model_type değerine bağlıdır.
Standart üretim (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Smart Topology üretim (model_type: smart-topology):
- meshy-t2 (varsayılan): Smart Topology modeli — temiz topology, doğal olarak ayrılan parçalar, üçgen çıktı ve target_polycount ile ayarlanabilir bir yüz sayısı.
Name
ultra_mode
Type
boolean
varsayılan false
Description
Daha yüksek hassasiyetli geometri için Ultra oluşturmayı etkinleştirir ve daha ince yüzey detayı olur. Üretim daha uzun sürer ve 5 kredi ekler.
Yalnızca ai_model meshy-7 (veya latest) ve yalnızca preview modunda desteklenir.
Name
should_remesh
Type
boolean
varsayılan false (meshy-6, meshy-7), true (others)
Description
Yeniden ağ oluşturma aşamasını etkinleştirip etkinleştirmemeyi kontrol eder. En yüksek kalitede model için should_remesh değerini false olarak ayarlamanızı öneririz.

Yalnızca şu durumlarda geçerli should_remesh = true

Name
topology
Type
string
varsayılan triangle
Description
Üretilen modelin topolojisini belirtin.
Mevcut değerler:
- quad: Dörtgen ağırlıklı bir ağ oluşturur.
- triangle: Azaltılmış üçgen ağ oluşturur.
Smart Topology çıktısı yalnızca üçgen şeklindedir. quad talep etmek ai_model: meshy-t2 ile birlikte bir hata döndürür.
Name
decimation_mode
Type
integer
Description
Poligon sayısı seviyesini belirleyerek adaptif azaltmayı etkinleştirir. Ayarlandığında, target_polycount göz ardı edilir.
Mevcut değerler:
- 1: Adaptif — ultra poligon sayısı.
- 2: Adaptif — yüksek poligon sayısı.
- 3: Adaptif — orta poligon sayısı.
- 4: Adaptif — düşük poligon sayısı.

Name
target_polycount
Type
integer
Description
Çıkıştaki poligonların (yüzlerin) hedef sayısı. Geometriye bağlı olarak gerçek sayı hedeften sapabilir.
target_polycount iki bağımsız durumda etkili olur:
- Yeniden Ağ — standard modeli üzerinde should_remesh: true. Ağ, yaklaşık bu sayıya yeniden ağ (decimated) olarak indirilir. Aralık 100 ila 300,000, varsayılan 30,000. Eğer decimation_mode ayarlanmışsa, öncelik kazanır ve target_polycount göz ardı edilir.
- Smart Topology — model_type: smart-topology ve ai_model: meshy-t2. Model doğrudan bu yüz sayısında oluşturulur; tekrar ağ işlemi çalışmaz ve should_remesh gerekmez. Aralık 100 ila 15,000, varsayılan 4,000.

Name
symmetry_mode
Type
string
⚠ kullanımdan kaldırıldı
varsayılan auto
Description
Kullanımdan kaldırıldı. Bu parametre artık çıkışı etkilemez.
symmetry_mode alanı, model üretim sürecinde simetri davranışını kontrol eder.
Geçerli değerler şunlardır:
- off: Simetriyi devre dışı bırakır.
- auto: Giriş geometrisine dayalı olarak simetriyi otomatik belirler ve uygular.
- on: Üretim sırasında simetriyi zorlar.
Name
pose_mode
Type
string
varsayılan ""
Description
Oluşturulan modelin poz modunu belirtin.
Mevcut değerler:
- a-pose: Modeli bir A duruşunda üretir.
- t-pose: Modeli bir T duruşunda üretir.
- "" (boş string): Belirli bir poz uygulanmaz.
Name
is_a_t_pose
Type
boolean
⚠ kullanımdan kaldırıldı
varsayılan false
Description
Bunun yerine pose_mode kullanın. Modelin bir A/T duruşunda olup olmadığını belirtir.
Name
art_style
Type
string
⚠ kullanımdan kaldırıldı
varsayılan realistic
Description
Meshy-6 tarafından desteklenmiyor. Meshy-6'yı kullanan talepler art_style göz ardı edecek ve bazı kombinasyonlar hatalara neden olabilir. Mevcut değerler: realistic, sculpture.
Heykel stilini kullanırken enable_pbr değerinin false olarak ayarlanması gereklidir çünkü Heykel stili kendi PBR haritalar kümesini oluşturur.
Name
moderation
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, giriş içeriği potansiyel olarak zararlı içerik için otomatik olarak taranacaktır. Zararlı içerik tespit edilirse, görev üretime devam etmez.
prompt içeriğinde metin taranır.
Name
target_formats
Type
string[]
Description
Çıkışa dahil edilecek 3D dosya formatlarını belirtir. Yalnızca istenen formatlar oluşturulup döndürüleceği için görev tamamlama süresini kısaltabilir. Atlandığında, tüm desteklenen formatlar dahil edilir.
Mevcut değerler: glb, obj, fbx, stl, usdz, 3mf
Atlandığında, 3mf dışındaki tüm formatlar oluşturulur. 3mf yalnızca açıkça belirtildiğinde dahil edilir.
Name
alpha_thumbnail
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, görev ayrıca önizlemenin şeffaf bir arka plan (RGBA) versiyonunu oluşturur ve GET yanıtında alpha_thumbnail_url olarak döndürür. Mevcut thumbnail_url alanı değişmez.
Name
auto_size
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, hizmet AI görüsünü kullanarak nesnenin gerçek dünya yüksekliğini otomatik olarak tahmin eder ve modeli buna göre yeniden boyutlandırır. origin_at açıkça ayarlanmadıkça orijin bottom olarak varsayılır.

Yalnızca şu durumlarda geçerli auto_size = true

Name
origin_at
Type
string
varsayılan bottom
Description
auto_size etkin olduğunda orijinin konumu.
Mevcut değerler: bottom, center.

Dönüş Değerleri

Yanıtın result özelliğinde, yeni oluşturulan Metinden 3D'ye görevin id si bulunur.

Başarısızlık Durumları

Name
400 - Bad Request
Description
İstek kabul edilemez idi. Yaygın nedenler:
- Eksik parametre: Gerekli bir parametre (örneğin, prompt, mode) eksik.
- Geçersiz parametre: art_style izin verilen değerlerden biri değil.
- Prompt çok uzun: prompt karakter sınırını aşıyor.
Name
401 - Unauthorized
Description
Kimlik doğrulama başarısız. Lütfen API anahtarınızı kontrol edin.
Name
402 - Payment Required
Description
Bu görevi gerçekleştirmek için yetersiz krediniz var.
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.

Request

POST

/openapi/v2/text-to-3d

# Gerekli parametrelerle basit önizleme
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Yeniden ağ ve A-duruşu ile önizleme
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

POST/openapi/v2/text-to-3d

Bir Metinden 3D İyileştirme Görevi Oluştur

Bu uç nokta, tamamlanmiş bir önizleme ağına doku uygulayan bir Metinden 3D iyileştirme görevi oluşturur. Başarılı bir önizleme görevinin görev kimliğini sağlamalısınız. Bu, iki adımlı iş akışının ikinci adımıdır.

Parametreler

Name
mode
Type
string
Zorunlu
Description
Bir iyileştirme görevi oluştururken bu alan "refine" olarak ayarlanmalıdır.
Name
preview_task_id
Type
string
Zorunlu
Description
İlgili önizleme görev kimliği.
Verilen önizleme görevinin durumu SUCCEEDED olmalıdır.
Name
enable_pbr
Type
boolean
varsayılan false
Description
Temel rengin yanı sıra PBR Haritaları (metalik, pürüzlülük, normal) üretin. ai_model meshy-6 olduğunda emission haritası da dahil edilir, texture_resolution: 8k hariç (hiçbir emission haritası üretilmiyor). meshy-7 (ve latest) bir emission haritası üretmiyor.
Name
texture_resolution
Type
string
varsayılan 2k
Description
Temel renk doku çözünürlüğü. 2k (2048×2048), 4k (4096×4096) veya 8k (8192×8192) olabilir. Daha yüksek çözünürlükler daha fazla yüzey detayını yakalar. Yalnızca refine moduna uygulanır.
4k ve 8k, ai_model meshy-6, meshy-7 veya latest gerektirir. 8k'da, emission haritası üretilmez.
Name
hd_texture
Type
boolean
⚠ kullanımdan kaldırıldı
varsayılan false
Description
Bunun yerine texture_resolution kullanın — texture_resolution: "4k"'a eşdeğer. Her ikisi de ayarlandığında, texture_resolution öncelik kazanır.
Name
texture_prompt
Type
string
Description
Dokulama sürecini yönlendirmek için ek bir metin promptu sağlayın. Maksimum 600 karakter.
Name
texture_image_url
Type
string
Description
Dokulama sürecini yönlendirmek için 2D bir resim sağlayın. Şu anda .jpg, .jpeg ve .png formatlarını destekliyoruz.
Resmi sağlamak için iki yol vardır:
- Herkese açık erişilebilir URL: İnternetten erişilebilen bir URL
- Data URI: Görüntünün base64 ile kodlanmış bir data URI'si. Bir data URI örneği: data:image/jpeg;base64,<your base64-encoded image data>
Görüntü dokulaması, orijinal nesne ile yüklenen görüntü arasında önemli geometri farkları varsa optimal çalışmayabilir. Dokulama sürecini yönlendirmek için yalnızca bir texture_image_url veya texture_prompt kullanılabilir. Her iki parametre de sağlanırsa, varsayılan olarak modeli dokuya bürümek için texture_prompt kullanılacaktır.
Name
ai_model
Type
string
varsayılan latest
Description
İyileştirme için kullanılacak model kimliği. Mevcut değerler: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
latest burada önizleme görevinde olduğu gibi çözülür (şu anda Meshy 7), dolayısıyla latest bir önizleme ve onun latest iyileştirmesi her zaman aynı doku modeline ulaşır.
Name
moderation
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, giriş içeriği potansiyel olarak zararlı içerik için otomatik olarak taranacaktır. Zararlı içerik tespit edilirse, görev üretime devam etmez.
Hem texture_prompt'daki metin hem de texture_image_url'den gelen görüntü taranacaktır.
Name
remove_lighting
Type
boolean
varsayılan true
Description
Temel renk dokusundan parlaklık ve gölgeleri kaldırır, böylece özel aydınlatma ayarları altında daha iyi çalışan daha temiz bir sonuç üretir.
Yalnızca ai_model meshy-6 olduğunda etkili olur. meshy-7 (ve latest) üzerinde bu parametre kabul edilir ancak göz ardı edilir.
Name
target_formats
Type
string[]
Description
Çıkışa dahil edilecek 3D dosya formatlarını belirtir. Yalnızca istenen formatlar oluşturulup döndürüleceği için görev tamamlama süresini kısaltabilir. Atlandığında, tüm desteklenen formatlar dahil edilir.
Mevcut değerler: glb, obj, fbx, stl, usdz, 3mf
Atlandığında, 3mf dışındaki tüm formatlar oluşturulur. 3mf yalnızca açıkça belirtildiğinde dahil edilir.
Name
alpha_thumbnail
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, görev ayrıca önizlemenin şeffaf bir arka plan (RGBA) versiyonunu oluşturur ve GET yanıtında alpha_thumbnail_url olarak döndürür. Mevcut thumbnail_url alanı değişmez.
Name
auto_size
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, hizmet AI görüsünü kullanarak nesnenin gerçek dünya yüksekliğini otomatik olarak tahmin eder ve modeli buna göre yeniden boyutlandırır. origin_at açıkça ayarlanmadıkça orijin bottom olarak varsayılır.

Yalnızca şu durumlarda geçerli auto_size = true

Name
origin_at
Type
string
varsayılan bottom
Description
auto_size etkin olduğunda orijinin konumu.
Mevcut değerler: bottom, center.

Dönüş Değerleri

Yanıtın result özelliğinde, yeni oluşturulan Metinden 3D'ye görevin id si bulunur.

Başarısızlık Durumları

Name
400 - Bad Request
Description
İstek kabul edilemez idi. Yaygın nedenler:
- Geçersiz görev kimliği: preview_task_id geçersiz veya mevcut değil.
- Görev henüz hazır değil: Önizleme görevi henüz başarılı olmadı.
- Model uyumsuzluğu: Önizleme görevinin AI modeli talep edilen iyileştirme modeli ile uyumsuz.
Name
401 - Unauthorized
Description
Kimlik doğrulama başarısız. Lütfen API anahtarınızı kontrol edin.
Name
402 - Payment Required
Description
Bu görevi gerçekleştirmek için yetersiz krediniz var.
Name
404 - Not Found
Description
preview_task_id ile belirtilen önizleme görevi bulunamadı.
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.

Request

POST

/openapi/v2/text-to-3d

# Temel iyileştirme görevi
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Otomatik boyut ve GLB formatında iyileştirme
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

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

GET/openapi/v2/text-to-3d/:id

Bir Metinden 3D Görevini Al

Bu uç nokta, geçerli bir görev id si verildiğinde bir Metinden 3D'ye görevi almanızı sağlar. Metinden 3D'ye görev nesnesiyle hangi özelliklerin dahil edildiğini görmek için Metinden 3D'ye Görev Nesnesi bölümüne bakın.

Bu uç nokta, hem önizleme hem de iyileştirme görevleri için çalışır.

Parametreler

Name
id
Type
path
Description
Alınacak Metinden 3D'ye görevin benzersiz tanımlayıcısı.

Dönüş Değerleri

Yanıt, Metinden 3D'ye görev nesnesini içerir. Ayrıntılar için Metinden 3D'ye Görev Nesnesi bölümüne bakın.

Örnekler

Mod	Örnek Model
Önizleme
İyileştirme

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

Bir Metinden 3D Görevini Sil

Bu uç nokta, bir Metinden 3D görevini kalıcı olarak siler, buna ilgili tüm modeller ve veriler de dahildir. Bu eylem geri alınamaz.

Yol Parametreleri

Name
id
Type
path
Description
Silinecek Metinden 3D'ye görevin kimliği.

Dönüş Değerleri

Başarı durumunda 200 OK döner.

Request

DELETE

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Başarı durumunda 200 Ok döner.

GET/openapi/v2/text-to-3d

Metinden 3D Görevlerini Listele

Bu uç nokta, bir dizi Metinden 3D'ye görev 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 50 öğedir.
Name
sort_by
Type
string
Description
Sıralama için alan.
Mevcut değerler:
- +created_at: Oluşturulma zamanına göre artan sırayla sıralayın.
- -created_at: Oluşturulma zamanına göre azalan sırayla sıralayın.

Dönüş Değerleri

Sayfalı bir Metinden 3D Görev Nesneleri listesi döndürür.

Request

GET

/openapi/v2/text-to-3d

curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

Bir Metinden 3D Görevini Yayınla

Bu uç nokta, Sunucu Tarafından Gönderilen Etkinlikler (SSE) kullanarak bir Metinden 3D görev için gerçek zamanlı güncellemeleri yayar.

Parametreler

Name
id
Type
path
Description
Yayınlanacak Metinden 3D görevinin benzersiz tanımlayıcısı.

Dönüş Değerleri

Sunucu Tarafından Gönderilen Etkinlikler olarak Metinden 3D Görev Nesneleri akışını döndürür.

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

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Hata etkinlik örneği
event: error
data: {
  "status_code": 404,
  "message": "Görev bulunamadı"
}

// Mesaj etkinlik örnekleri görev ilerlemesi gösterir.
// PENDING veya IN_PROGRESS görevleri için yanıt akışı tüm alanları içermeyecektir.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"texture_urls": [
  {
    "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
    "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
    "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
    "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
    "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
  }
],
"preceding_tasks": 0,
"task_error": {

  "message": ""

},

"consumed_credits": 20
}

Metinden 3D Görev Nesnesi

Metinden 3D Görev nesnesi, Meshy'nin bir metin girdisinden 3D model oluşturmak için takip ettiği bir iş birimidir. Metinden 3D API'sinin iki aşaması vardır, preview ve refine. Önizleme aşaması, yalnızca ağ model oluşturmak için ve iyileştirme aşaması ise önizleme aşamasının sonuçlarına dayalı olarak dokulu 3D model üretmek içindir.

Nesne aşağıdaki özelliklere sahiptir:

Özellikler

Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı. Biz görev kimlikleri için k-sıralamalı UUID kullanırken, id formatı hakkında hiçbir varsayım yapmamalısınız.
Name
type
Type
string
Description
Metinden 3D görevinin türü. Olası değerler, önizleme aşaması görevleri için text-to-3d-preview ve iyileştirme aşaması görevleri için text-to-3d-refine.
Name
model_urls
Type
object
Description
Meshy tarafından üretilen dokulu 3D model dosyasının indirilebilir URL'si. Format üretilmediğinde, bir boş dize döndermek yerine format için bir özellik yok edilerek sağlanacaktır.
- Name
  glb
  Type
  string
  Description
  GLB dosyasının indirilebilir URL'si.
- Name
  fbx
  Type
  string
  Description
  FBX dosyasının indirilebilir URL'si.
- Name
  usdz
  Type
  string
  Description
  USDZ dosyasının indirilebilir URL'si.
- Name
  obj
  Type
  string
  Description
  OBJ dosyasının indirilebilir URL'si.
- Name
  mtl
  Type
  string
  Description
  MTL dosyasının indirilebilir URL'si.
- Name
  stl
  Type
  string
  Description
  STL dosyasının indirilebilir URL'si.
- Name
  3mf
  Type
  string
  Description
  3MF dosyasının indirilebilir URL'si. Yalnızca target_formats ile 3mf talep edildiğinde mevcut olur.
Name
prompt
Type
string
Description
Görevi oluşturmak için kullanılan değiştirilmemiş prompt.
Name
negative_prompt
Type
string
⚠ kullanımdan kaldırıldı
Description
Geriye dönük uyumluluk için korunmuştur. Bu alanın üretilen modeller üzerinde hiçbir işlevsel etkisi yoktur.
Name
art_style
Type
string
⚠ kullanımdan kaldırıldı
Description
Önizleme görevinin oluşturulmasında kullanılan değiştirilmemiş art_style. Meshy-6 tarafından desteklenmiyor.
Name
texture_richness
Type
string
⚠ kullanımdan kaldırıldı
Description
Geriye dönük uyumluluk için korunmuştur. Bu alanın üretilen modeller üzerinde hiçbir işlevsel etkisi yoktur.
Name
texture_prompt
Type
string
Description
İyileştirme aşamasında dokulama sürecini yönlendirmek için sağlanan ek metin promptu.
Name
ultra_mode
Type
boolean
Description
Önizleme görevi ultra_mode değeri ile oluşturulduğunda yankılanır. Sadece meshy-7 (veya latest) önizleme görevlerinde ultra_mode açıkça ayarlandığında mevcut; aksi halde yoktur.
Name
texture_image_url
Type
string
Description
Dokulama sürecini yönlendirmek için kullanılan texture görüntüsünün indirilebilir URL'si.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resim görüntüsünün indirilebilir URL'si.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url'un şeffaf bir arka plan (RGBA) versiyonun indirilebilir URL'si. Bu alan yalnızca görev alpha_thumbnail: true ile oluşturulduğunda ve şeffaf önizleme başarıyla render edildiğinde mevcuttur; aksi halde bu alan atlanır.
Name
video_url
Type
string
⚠ kullanımdan kaldırıldı
Description
Önizleme videosunun indirilebilir URL'si. Gelecekteki bir sürümde kaldırılacaktır.
Name
progress
Type
integer
Description
Görevin ilerlemesi. Görev henüz başlamadıysa, bu alan 0 olacaktır. Görev başarıyla tamamlandığında, bu 100 olur.
Name
started_at
Type
timestamp
Description
Görev başladığında milisaniye cinsinden zaman damgası. Eğer görev henüz başlamadıysa, bu alan 0 olacaktır.
Bir zaman damgası, 1 Ocak 1970 UTC'den bu yana geçen milisaniye sayısını temsil eder ve RFC 3339 standardını takip eder. Örneğin, Cuma, 1 Eylül 2023 12:00:00 PM GMT 1693569600000 olarak temsil edilir. Bu, Meshy API'deki tüm zaman damgaları için geçerlidir.
Name
created_at
Type
timestamp
Description
Görev oluşturulduğunda milisaniye cinsinden zaman damgası.
Name
finished_at
Type
timestamp
Description
Görev tamamlandığında milisaniye cinsinden zaman damgası. Eğer görev henüz tamamlanmadıysa, bu alan 0 olacaktır.
Name
status
Type
string
Description
Görevin durumu. Olası değerler PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED'dır.
Name
texture_urls
Type
array
Description
Görevden üretilen doku URL nesnelerinin bir dizisi. Normalde bu yalnızca bir doku URL nesnesi içerir. Her bir doku URL'sinin aşağıdaki özellikleri vardır:
- Name
  base_color
  Type
  string
  Description
  Temel renk harita görüntüsünün indirilebilir URL'si.
- Name
  metallic
  Type
  string
  Description
  Metalik harita görüntüsünün indirilebilir URL'si.
  Görev enable_pbr: false ile oluşturulduğunda, bu alan atlanır.
- Name
  normal
  Type
  string
  Description
  Normal harita görüntüsünün indirilebilir URL'si.
  Görev enable_pbr: false ile oluşturulduğunda, bu alan atlanır.
- Name
  roughness
  Type
  string
  Description
  Pürüzlülük harita görüntüsünün indirilebilir URL'si.
  Görev enable_pbr: false ile oluşturulduğunda, bu alan atlanır.
- Name
  emission
  Type
  string
  Description
  Emisyon harita görüntüsünün indirilebilir URL'si.
  Görev enable_pbr: false ile oluşturulduğunda veya ai_model meshy-5 olduğunda, bu alan atlanır.
Name
preceding_tasks
Type
integer
Description
Önceki görevlerin sayısı.
Bu alanın değeri anlamlıdır, ancak görev durumu PENDING olduğunda anlamlıdır.
Name
task_error
Type
object
Description
Başarısız görevler için hata ayrıntıları. Tam task_error objesi referansı için Hatalar bölümüne bakın.
Name
consumed_credits
Type
integer
Description
Bu görev tarafından tüketilen kredi sayısı. Görev durumu PENDING, IN_PROGRESS veya SUCCEEDED olduğunda mevcut. FAILED görevler için 0 döner (krediler başarısızlıkta iade edilir).

Örnek Metinden 3D Görev Nesnesi

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}