Lewati ke konten utama

Model Respons Bersama

Menjelaskan skema respons bersama yang digunakan di Aether API.

JobIdResponse​

Dikembalikan oleh semua endpoint POST yang membuat pekerjaan asinkron.

Skema​

FieldTipeDeskripsi
job_idstring (UUID)Pengidentifikasi unik pekerjaan yang dibuat

Contoh​

{
"job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Endpoint yang Menggunakan​

  • POST /public/v1/generate/image
  • POST /public/v1/generate/effect/v1
  • POST /public/v1/generate/effect/v2
  • POST /public/v1/image-tune/upscale
  • POST /public/v1/image-tune/inpaint/v1
  • POST /public/v1/image-tune/inpaint/v2
  • POST /public/v1/image-tune/remove-background
  • POST /public/v1/image-tune/equip-variation
  • POST /public/v1/sprite/lite
  • POST /public/v1/sprite/plus
  • POST /public/v1/sprite/zenith
  • POST /public/v1/sprite/pulsar

GetJobStatusResponse​

Dikembalikan oleh endpoint pemeriksaan status pekerjaan.

Skema​

FieldTipeWajibDeskripsi
job_idstring (UUID)YaPengidentifikasi unik pekerjaan
statusstringYaStatus pekerjaan (Pending, Succeed, Failed)
image_urlsarray[string]TidakDaftar URL gambar yang selesai (hanya disediakan dalam status Succeed)

Contoh Respons Berdasarkan Status​

Pending​

{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Pending",
"image_urls": []
}

Succeed​

{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Succeed",
"image_urls": ["https://cdn.aetherforgeai.com/images/abc123.png"]
}

Failed​

{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Failed",
"image_urls": []
}

Endpoint yang Menggunakan​

  • GET /public/v1/job/{job_id}

Dokumen Terkait​