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 Field | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| description | string | Ya | Deskripsi teks untuk efek yang akan dibuat |
| resolution | string | Ya | Resolusi output. Nilai yang diizinkan: 1K, 2K, 4K |
| image | file | Tidak | File gambar referensi opsional untuk memandu efek yang dibuat |
Respons
Respons Sukses (200 OK):
{
"job_id": "uuid-string"
}
| Field | Tipe | Deskripsi |
|---|---|---|
| job_id | string | Pengidentifikasi unik pekerjaan yang dibuat. Ambil hasil dengan Dapatkan Status Pekerjaan |
Aturan Kesalahan / Validasi
| Situasi | Status HTTP | Pesan Kesalahan |
|---|---|---|
| Invalid image file | 400 | "Invalid image file" |
| Kunci API tidak valid | 401 | Invalid 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:
- Simpan
job_idyang diterima dari respons - Lakukan polling ke
GET /public/v1/job/{job_id}untuk memeriksa status - Ketika status menjadi
Succeed, periksa hasil diimage_urls
Alur Status: Pending → Succeed 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"