Pekerjaan asinkron
Dapatkan Status Task
Ambil status dan hasil dari task async apa pun menggunakan poll_url yang dikembalikan oleh endpoint create
Gambaran Umum
Gunakan endpoint ini untuk polling async terpadu di berbagai jenis task seperti pembuatan video, gambar, musik, dan 3D.
Jika respons create menyertakan poll_url, panggil path tersebut secara persis. Untuk alur kerja async yang lebih baru, poll_url dapat mengarah ke /v1/tasks/{id}.
Parameter Path
ID task yang dikembalikan oleh permintaan create.
Respons
Field hasil, error, timestamp, dan model dikembalikan jika tersedia untuk task.
Pengidentifikasi task.
Alias pengenal tugas asinkron.
URL polling yang diutamakan saat respons pembuatan menyediakannya.
Status task seperti pending, processing, completed, atau failed. Task yang dibatalkan direpresentasikan sebagai failed dengan cancelled: true.
true ketika async task yang masih antre dibatalkan sebelum eksekusi.
Penanda pembatalan. Ada sebagai cancelled ketika pembatalan berhasil.
Untuk task gambar yang selesai, hasil gambar yang dibuat dikembalikan di sini. Task gambar mengembalikan URL di data[].url.
Nilai progres opsional. Hanya dikembalikan saat nilai progres nyata tersedia; gunakan status untuk menentukan penyelesaian.
URL aset hasil ketika task selesai dan menghasilkan video.
Objek video tunggal dengan url, duration, width, dan height saat tersedia.
Array video saat tugas pembuatan mengembalikan lebih dari satu output.
Timestamp pembuatan.
Timestamp pembaruan terakhir.
Model yang digunakan oleh tugas.
Pesan error ketika task gagal.
Perilaku Error
Task publik yang kedaluwarsa atau tidak tersedia dapat mengembalikan 404 async_task_not_found. Jika kepemilikan task untuk API key saat ini tidak dapat dipastikan, responsnya adalah 403 task_not_owned.
{
"error": {
"message": "Task not found or no longer available.",
"type": "invalid_request_error",
"code": "async_task_not_found"
}
}Contoh
Permintaan
curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"import requests
poll_url = "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
response = requests.get(
f"https://api.tokenlab.sh{poll_url}",
headers={"Authorization": "Bearer sk-your-api-key"},
)
print(response.json())const pollUrl = '/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
const response = await fetch(`https://api.tokenlab.sh${pollUrl}`, {
headers: { Authorization: 'Bearer sk-your-api-key' },
});
console.log(await response.json());{ "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", "videos": [ {} ], "data": [ {} ], "audio_url": "string", "title": "string", "lyrics": "string", "model_url": "string", "glb_url": "string", "fbx_url": "string"}Otorisasi
BearerAuth Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.
Lokasi: header
Parameter path
ID tugas asinkron yang dikembalikan oleh id / task_id, atau disematkan dalam poll_url
Respons
application/json
application/json
application/json
application/json