Kullanım API'si
Faturalandırma dışa aktarımları ve maliyet raporları için ekibinizin tamamlanmış API görevlerini ve her birinin kullandığı kredileri listeleyin.
Bu uç noktayı çağırmak için bir Studio veya Enterprise ekibinin aktif bir üyesinin API anahtarını kullanın. Yalnızca sahipler ve yöneticiler değil, herhangi bir üye bunu çağırabilir. Başka herhangi bir API anahtarıyla istek 403 döner.
Kullanım kayıtlarını listele
Ekibinizin kullanım kayıtlarının bir sayfasını, varsayılan olarak en yeniden en eskiye doğru döndürür. start_time ve end_time olmadan kayıtlar son 30 günü kapsar. Bu uç noktayı çağırmak ücretsizdir.
Kayıtlar şu görevleri içerir:
SUCCEEDEDveyaFAILEDolarak tamamlanan API görevleri- Ekibin tüm mevcut üyelerinin, herhangi bir API anahtarından gelen görevleri
- Sildiğiniz görevler ve dosyaları süresi dolmuş görevler
Kayıtlar şu görevleri dışarıda bırakır:
- Hâlâ
PENDINGveyaIN_PROGRESSolan görevler ileCANCELEDgörevler - Ekipten ayrılmış kişilerin görevleri
- Creative Lab görevleri
- Meshy'nin yapay zekâ ajanlarının çalıştırdığı görevler
- Meshy web uygulamasında yapılan işler
Bir görev, kayıtlarda yalnızca tamamlandıktan sonra, created_at zaman aralığında görünür. Meshy, bir görev oluşturduğunda kredi tahsil eder, bu yüzden hâlâ çalışmakta olan bir görev kayıtlarda bulunmaz. Kayıtları kredi bakiyenizle uzlaştırmadan önce son zaman aralıklarını yeniden çekin veya dışa aktarmayı kısa bir gecikmeyle yapın.
Ekibinizin bir veri saklama süresi varsa, zaman aralığı bu sürenin izin verdiğinden daha erken başlamaz.
Request
curl "https://api.meshy.ai/openapi/v1/usage/tasks?page_size=50&start_time=2026-08-01T00:00:00Z&end_time=2026-09-01T00:00:00Z" \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"endpoint": "image-to-3d",
"status": "SUCCEEDED",
"created_at": 1755787000000,
"finished_at": 1755787045000,
"consumed_credits": 20,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {
"user": "alex@example.com",
"team": "fab"
}
},
{
"task_id": "018a210d-1c22-7e0f-9d3a-4a5b6c7d8e9f",
"endpoint": "text-to-3d-refine",
"status": "FAILED",
"created_at": 1755786000000,
"finished_at": 1755786030000,
"consumed_credits": 0,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {}
}
]
Parametreler
- Name
- page_num
- Type
- integer
- varsayılan 1
- Description
Döndürülecek sayfa,
1ile255arasında.255'in üzerindeki bir değer400döner. Bir zaman aralığı en fazla 255 sayfa barındırır, bu yüzden büyük bir dışa aktarımı daha kısa zaman aralıklarına bölün.
- Name
- page_size
- Type
- integer
- varsayılan 10
- Description
Sayfa başına kayıt sayısı,
1ile100arasında.101ile255arasındaki bir değer 100 kayıt döndürür,255'in üzerindeki bir değer ise400döner.
- Name
- sort_by
- Type
- string
- varsayılan -created_at
- Description
Sıralama düzeni.
Kullanılabilir değerler:
+created_at: en eskiden en yeniye-created_at: en yeniden en eskiye
Bir URL'de
+işaretini%2Bolarak yazın. Aksi hâlde+bir boşluk olarak okunur ve istek400döner.
- Name
- start_time
- Type
- string
- Description
Zaman aralığının başlangıcı, örneğin
2026-08-01T00:00:00Zgibi bir RFC 3339 zaman damgası olarak. Kayıtlar, bu zamanda veya sonrasında oluşturulan görevleri içerir. Zaman aralığınınend_time'dan 30 gün önce başlaması için bunu belirtmeyin.Zaman aralığı en fazla 366 gün sürebilir. Daha uzun bir aralık
400döner, bu yüzden daha uzun bir dışa aktarımı birkaç aralığa bölün.
- Name
- end_time
- Type
- string
- Description
Zaman aralığının sonu, bir RFC 3339 zaman damgası olarak. Kayıtlar, bu zamandan önce oluşturulan görevleri içerir. Zaman aralığının isteğinizin yapıldığı anda sona ermesi için bunu belirtmeyin.
- Name
- endpoints
- Type
- string
- Description
Dahil edilecek uç noktaların,
endpointalanıyla aynı adlarla virgülle ayrılmış bir listesi. Her uç noktayı dahil etmek için bunu belirtmeyin. Bilinmeyen bir ad400döner.Kullanılabilir değerler:
text-to-3d: önizleme ve refine dahil her Metinden 3D'ye görevitext-to-3d-preview: yalnızca önizleme görevleritext-to-3d-refine: yalnızca refine görevleriimage-to-3dmulti-image-to-3dretextureremeshconvertresizeuv-unwrapriganimatetext-to-motiontext-to-imageimage-to-imageprint-multi-colorprint-repairprint-analyzeprint-splitrelief
- Name
- status
- Type
- string
- Description
Dahil edilecek durum,
SUCCEEDEDveyaFAILED. Her ikisini de dahil etmek için bunu belirtmeyin. Başka herhangi bir değer400döner.
Döndürülenler
Bir kullanım kayıtları dizisi döndürür. Eşleşen kayıt olmadığında dizi boştur.
Hata modları
- Name
400 - Bad Request- Description
Bir parametre geçersiz ve hata mesajı hangisi olduğunu belirtir. Parametreyi düzeltin, ardından isteği yeniden gönderin.
- Name
401 - Unauthorized- Description
API anahtarı eksik veya geçersiz.
Authorizationbaşlığını kontrol edin.
- Name
403 - Forbidden- Description
API anahtarının hesabı, bir Studio veya Enterprise ekibinin aktif bir üyesi değil. Mesaj
This endpoint is available on Studio and Enterprise plansşeklindedir. Bir Studio veya Enterprise ekibi üyesinin API anahtarını kullanın.
- Name
429 - Too Many Requests- Description
Çok fazla istek gönderdiniz.
Retry-Afteriçindeki saniye kadar bekleyin, ardından yeniden deneyin.
Kullanım kaydı nesnesi
Example usage record object
{
"task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"endpoint": "image-to-3d",
"status": "SUCCEEDED",
"created_at": 1755787000000,
"finished_at": 1755787045000,
"consumed_credits": 20,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {
"user": "alex@example.com",
"team": "fab"
}
}
- Name
- task_id
- Type
- string
- Description
Görev kimliği, oluşturan uç noktanın döndürdüğü kimlikle aynıdır. Görevin kendisini, çıktı URL'leriyle birlikte almak için kimliği o uç noktanın get rotasına gönderin, örneğin bir
image-to-3dkaydı içinGET /openapi/v1/image-to-3d/{task_id}.
- Name
- endpoint
- Type
- string
- Description
Görevin çalıştığı uç nokta, örneğin
image-to-3dveyarig. Bir Metinden 3D'ye görevi, aşamasını gösterir:text-to-3d-previewveyatext-to-3d-refine.Daha eski kayıtlarda,
endpointsfiltresinin kabul etmediği, artık kullanılmayan uç noktaların adları bulunabilir.
- Name
- status
- Type
- string
- Description
Görevin nihai durumu,
SUCCEEDEDveyaFAILED.
- Name
- created_at
- Type
- timestamp
- Description
Görevin oluşturulduğu zaman, Unix milisaniye cinsinden.
- Name
- finished_at
- Type
- timestamp
- Description
Görevin tamamlandığı zaman, Unix milisaniye cinsinden. Görevin bir bitiş zamanı yoksa
null.
- Name
- consumed_credits
- Type
- integer
- Description
Görevin kullandığı kredi sayısı, geri ödemelerden sonra. Başarısız bir görev için
0, çünkü Meshy bunu geri öder; ayrıca Basılabilirliği analiz et gibi ücretsiz bir görev için de0.
- Name
- api_key_name
- Type
- string
- Description
Görevi çalıştıran API anahtarının adı. Bir uygulama girişiyle çalıştırılan görev için bu, uygulamanın adıdır, örneğin
Meshy CLI.Bazı durumlarda boş bir dizedir, örneğin:
- Görev hiç ücretlendirilmedi, Basılabilirliği analiz et görevi gibi; bu ücretsizdir.
- API anahtarı silinmiş.
- API anahtarı son birkaç dakika içinde oluşturulmuş.
- Name
- api_key_suffix
- Type
- string
- Description
Aynı ada sahip anahtarları birbirinden ayırt etmek için o API anahtarının son dört karakteri.
api_key_nameboş olduğunda ve Meshy CLI gibi uygulama girişlerinde boş bir dizedir.
- Name
- metadata
- Type
- object
- Description
Görev oluşturulduğunda
X-Meshy-Metadatabaşlığında gönderilen etiketler. Hiçbiri yoksa{}. Bkz. Metadata.