Asenkron işler

Görev Durumunu Al

Görüntü, video, müzik, 3D, Worlds ve asenkron ses transkripsiyonu gibi herhangi bir asenkron görevin durumunu ve sonucunu alın

GET
/v1/tasks/{id}

Genel Bakış

Herhangi bir asenkron görevi kontrol etmek için GET /v1/tasks/{id} kullanın. Bu uç nokta; görüntü, video, müzik, 3D, Worlds ve asenkron ses transkripsiyonu görevlerine hizmet eder. Oluşturma yanıtından gelen id veya task_id değerini iletin.

world_id ve world_marble_url gibi World sonuç alanları, World Durumunu Al bölümünde belgelenmiştir. Bir World görevi için X-Task-Type değeri 3d şeklindedir.

Çoğu görev için, oluşturma yanıtındaki poll_url bu yol ile aynıdır. Bir Worlds oluşturma yanıtı, /v1/worlds/generations/{id} altında bir poll_url döndürür; Worlds için de görev id'si ile /v1/tasks/{id} adresini sorgulayın.

/v1/images/{id}, /v1/videos/generations/{id}, /v1/music/generations/{id} ve /v1/3d/generations/{id} gibi modalite bazlı durum yolları, uyumluluk uç noktalarıdır. Mevcut entegrasyonlar için desteklenmeye devam etmektedirler.

Başarısız olan bir görev için durum okuma işlemi HTTP 200 döndürür. Sonucu görmek için HTTP koduna değil, status alanına bakın. Sonuç alanları görev türüne bağlıdır; Görüntü Durumunu Al, Video Durumunu Al, Müzik Durumunu Al ve 3D Durumunu Al bölümlerine bakın. Sonuç bağlantıları, 30 gün boyunca geçerli kalan TokenLab medya sonucu URL'leridir; Veri saklama bölümüne bakın.

Yol Parametreleri

idstringpathzorunlu

Oluşturma isteği tarafından döndürülen id veya task_id.

Yanıt

Sonuçları, hataları, zaman damgalarını ve modeli açıklayan alanlar, görev için mevcut olduklarında döndürülür.

idstring

Kanonik asenkron görev tanımlayıcısı.

task_idstring

Asenkron görev tanımlayıcı takma adı.

poll_urlstring

Bu görev için durum URL'si. id ile GET /v1/tasks/{id} sorgusu yapın.

billing_transaction_idstring

Görev için kaydedildiğinde faturalandırma işlem kimliği. X-Billing-Transaction-ID başlığı aynı değeri taşır. Bu bir görev tanımlayıcısı değil, faturalandırma tanımlayıcısıdır.

statusstring

Görev durumu: pending, processing, completed, failed veya timeout. completed, failed veya timeout durumlarında sorgulamayı durdurun. İptal edilen görevler, cancelled: true ile failed olarak temsil edilir.

cancelledboolean

Kuyruğa alınmış bir asenkron görev yürütülmeden önce iptal edildiğinde true değerini alır.

cancellation_statusstring

İptal işareti. İptal başarılı olduğunda cancelled olarak görünür.

dataarray

Tamamlanan görüntü görevleri için oluşturulan görüntü sonuçları burada döndürülür. Görüntü görevleri data[].url içinde URL'ler döndürür.

progressnumber

İsteğe bağlı ilerleme değeri. Yalnızca gerçek bir ilerleme değeri mevcut olduğunda döndürülür; tamamlanma durumunu belirlemek için status alanını kullanın.

video_urlstring

Görev tamamlandığında ve bir video ürettiğinde sonuç varlık URL'si.

videoobject

Mevcut olduğunda url, duration, width ve height içeren tek video yükü.

videosarray

Birden fazla çıktı mevcut olduğunda çoklu video yükleri.

errorstring | object

Görevin neden başarısız olduğu: bir metin veya message içeren bir nesne; biliniyorsa type, code, param ve retryable alanlarını da içerir.

error_detailsobject

Görev başarısız olduğunda hata ayrıntıları: status, message, type, code, retryable ve bir istek alanı hatalıysa param.

media_retentionobject

Sonuç bağlantılarının saklama durumu: days ve url, kind, status, expires_at içeren items[]. Mevcut olmayabilir; bağlantılar yine de çalışır.

createdinteger

Mevcut olduğunda oluşturma zaman damgası.

updatedinteger

Mevcut olduğunda son güncelleme zaman damgası.

modelstring

Mevcut olduğunda görev tarafından kullanılan model.

Yanıt Başlıkları

Başarılı durum yanıtları şu başlıkları içerir:

BaşlıkAçıklama
X-Task-IDGenel görev kimliği
X-Task-Typeimage, video, music, 3d veya audio gibi görev ailesi
Cache-Controlno-store. Durum yanıtlarını önbelleğe almayın
X-Billing-Transaction-IDKaydedildiğinde faturalandırma işlem kimliği
X-Task-CostGörev tamamlandığında belirlenen görev maliyeti

Hata Davranışı

HTTPKodAnlamı
400missing_task_id, invalid_task_idGörev kimliği eksik veya geçerli bir görev kimliği değil
403task_not_ownedGörev, bu API anahtarının çalışma alanına ait değil. Sorgulamayı durdurun
404async_task_not_foundGörev süresi dolmuş veya mevcut değil
503async_task_owner_unavailableGörev şu anda okunamıyor. Yeniden deneyin
{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

Örnekler

İstek

curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
{  "id": "string",  "status": "pending",  "progress": 0,  "created": 0,  "updated": 0,  "model": "string",  "video": {    "url": "string",    "duration": 0,    "width": 0,    "height": 0  },  "error": "string",  "error_details": {    "projection_version": 0,    "status": 400,    "message": "string",    "type": "string",    "code": "string",    "param": "string",    "retryable": true,    "upstream": {      "source": "string",      "code": "string",      "message": "string",      "param": "string"    }  },  "task_id": "string",  "poll_url": "string",  "cancelled": true,  "cancellation_status": "cancelled",  "billing_transaction_id": "string",  "video_url": "string",  "last_frame_url": "string",  "videos": [    {}  ],  "data": [    {}  ],  "audio_url": "string",  "title": "string",  "lyrics": "string",  "model_url": "string",  "glb_url": "string",  "fbx_url": "string",  "media_retention": {    "days": 0,    "items": [      {        "url": "http://example.com",        "kind": "image",        "content_type": "string",        "status": "saving",        "expires_at": "2019-08-24T14:15:22Z"      }    ]  }}

Yetkilendirme

BearerAuth
AuthorizationBearer <token>

API Anahtarı kimlik doğrulaması. API anahtarlarını Dashboard > API > API Keys bölümünden oluşturun veya yönetin.

Konum: header

Yol parametreleri

id*string

id / task_id tarafından döndürülen veya poll_url içine gömülü olan asenkron görev kimliği

Yanıt

application/json

application/json

application/json

application/json

application/json

application/json

application/json