Dapatkan Status Pekerjaan
Tujuan
Endpoint ini mengambil status dan hasil pekerjaan asinkron saat ini. Anda dapat memeriksa status pekerjaan seperti pembuatan gambar, upskala, inpaint, pemisahan lapisan, dll. melalui ID pekerjaan (job_id).
Metode dan Path
- HTTP Method:
GET - Path:
/public/v1/job/{job_id}
Autentikasi
Endpoint ini memerlukan autentikasi Bearer Token. Lihat Panduan Autentikasi untuk detailnya.
Header yang Diperlukan:
Authorization: Bearer {your_api_key}
Field Permintaan
Parameter Path
| Nama Field | Tipe | Wajib | Deskripsi |
|---|---|---|---|
job_id | UUID | Wajib | Pengidentifikasi unik pekerjaan yang akan diambil (format UUID) |
Respons
GetJobStatusResponse
| Nama Field | Tipe | Deskripsi |
|---|---|---|
job_id | UUID | Pengidentifikasi unik pekerjaan |
status | string | Status pekerjaan. Nilai yang mungkin: Pending, Succeed, Failed |
image_urls | list[string] | Daftar URL gambar yang selesai. Hanya disertakan ketika pekerjaan berhasil |
Nilai Status
- Pending: Pekerjaan sedang berlangsung atau menunggu
- Succeed: Pekerjaan berhasil diselesaikan
- Failed: Terjadi kesalahan saat memproses pekerjaan
Aturan Kesalahan / Validasi
| Kode Status HTTP | Situasi Kesalahan | Deskripsi |
|---|---|---|
401 Unauthorized | Gagal autentikasi | Kunci API tidak valid atau header autentikasi hilang |
404 Not Found | Pekerjaan tidak ditemukan | Tidak dapat menemukan pekerjaan yang sesuai dengan job_id tersebut |
422 Unprocessable Entity | Format job_id tidak valid | job_id harus berupa UUID yang valid |
Perilaku Pekerjaan Asinkron
Endpoint ini digunakan untuk mengambil status pekerjaan asinkron. Endpoint pembuatan pekerjaan (misalnya /image-tune/upscale) segera mengembalikan job_id, dan pemrosesan aktual berlangsung di latar belakang.
Strategi Polling:
- Setelah menerima
job_iddari pembuatan pekerjaan, lakukan polling ke endpoint ini untuk memeriksa status - Status awal adalah
Pending - Ketika pekerjaan selesai,
statusberubah menjadiSucceeddanimage_urlsberisi URL gambar hasil - Ketika pekerjaan gagal,
statusberubah menjadiFailed - Interval polling 1-2 detik direkomendasikan
Contoh Permintaan
cURL
curl -X GET "https://api.aetherforgeai.com/public/v1/job/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
Contoh Respons (Sukses - Pending)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Pending",
"image_urls": []
}
Contoh Respons (Sukses - Selesai)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Succeed",
"image_urls": ["https://cdn.aetherforgeai.com/images/generated_abc123.png"]
}
Contoh Respons (Gagal)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Failed",
"image_urls": []
}