Lewati ke konten utama

Buat Efek V1

Tujuan

Membuat hasil bergaya efek secara asinkron. Anda dapat memberikan deskripsi teks dan secara opsional mengunggah gambar untuk memandu pembuatan efek.

Metode dan Jalur

POST /public/v1/generate/effect/v1

Autentikasi

Lihat halaman Autentikasi. Token Bearer diperlukan.

Header yang Diperlukan:

Authorization: Bearer {your_api_key}

Bidang Permintaan

Nama FieldTipeWajibDeskripsi
descriptionstringYaDeskripsi teks untuk efek yang akan dibuat
resolutionstringYaResolusi output. Nilai yang diizinkan: 1K, 2K, 4K
imagefileTidakFile gambar referensi opsional untuk memandu efek yang dibuat

Respons

Respons Sukses (200 OK):

{
"job_id": "uuid-string"
}
FieldTipeDeskripsi
job_idstringPengidentifikasi unik pekerjaan yang dibuat. Ambil hasil dengan Dapatkan Status Pekerjaan

Aturan Kesalahan / Validasi

SituasiStatus HTTPPesan Kesalahan
Invalid image file400"Invalid image file"
Kunci API tidak valid401Invalid API key

Perilaku Pekerjaan Asinkron

Endpoint ini membuat pekerjaan asinkron. Ini segera mengembalikan job_id, dan pembuatan efek aktual berlangsung di latar belakang.

Cara Polling:

  1. Simpan job_id yang diterima dari respons
  2. Lakukan polling ke GET /public/v1/job/{job_id} untuk memeriksa status
  3. Ketika status menjadi Succeed, periksa hasil di image_urls

Alur Status: PendingSucceed atau Failed

Contoh Permintaan

cURL (tanpa gambar):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "resolution=1K"

cURL (dengan gambar):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a neon cyberpunk effect" \
-F "resolution=2K" \
-F "image=@/path/to/input.png"