Lewati ke konten utama

Dapatkan Status Pekerjaan

Tujuan​

Endpoint ini mengambil status dan hasil pekerjaan asinkron saat ini. Anda dapat memeriksa status pekerjaan seperti pembuatan gambar, efek, peningkatan kualitas, gambar ulang, penghapusan latar, pasang variasi, pembuatan sprite, dan pekerjaan lainnya 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 FieldTipeWajibDeskripsi
job_idUUIDWajibPengidentifikasi unik pekerjaan yang akan diambil (format UUID)

Respons​

GetJobStatusResponse​

Nama FieldTipeDeskripsi
job_idUUIDPengidentifikasi unik pekerjaan
statusstringStatus pekerjaan. Nilai yang mungkin: Pending, Succeed, Failed
image_urlslist[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 HTTPSituasi KesalahanDeskripsi
401 UnauthorizedGagal autentikasiKunci API tidak valid atau header autentikasi hilang
404 Not FoundPekerjaan tidak ditemukanTidak dapat menemukan pekerjaan yang sesuai dengan job_id tersebut
422 Unprocessable EntityFormat job_id tidak validjob_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_id dari pembuatan pekerjaan, lakukan polling ke endpoint ini untuk memeriksa status
  • Status awal adalah Pending
  • Ketika pekerjaan selesai, status berubah menjadi Succeed dan image_urls berisi URL gambar hasil
  • Ketika pekerjaan gagal, status berubah menjadi Failed
  • 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": []
}