Buat efek V2

Tujuan

Menghasilkan sprite sheet efek secara asinkron dari deskripsi teks dengan jumlah frame yang dipilih. Anda dapat mengunggah gambar referensi secara opsional dan memilih warna latar belakang sheet. Ini adalah fitur yang sama dengan tab V2 pada halaman "Buat efek" di aplikasi web (tab default).

Biaya kredit: 3

Metode dan Path

POST /public/v1/generate/effect/v2

Autentikasi

Lihat halaman autentikasi. Token Bearer diperlukan.

Header yang Diperlukan:

Authorization: Bearer {your_api_key}

Field Permintaan

Kirim permintaan sebagai multipart/form-data.

Nama Field	Tipe	Wajib	Deskripsi
description	string	Ya	Deskripsi efek. Spasi di awal dan akhir dihapus (trim)
frame	integer	Ya	Frame. Nilai yang diizinkan: 4, 9, 16
background_color	string	Ya	Warna latar belakang sheet. Nilai yang diizinkan: white, chroma_green, magenta, light_gray, light_purple, dark_gray
image	file	Tidak	Gambar referensi (opsional) (PNG atau JPEG)

Lihat Buat efek V1 untuk tabel warna latar belakang.

Respons

Respons Berhasil (200 OK):

{
  "job_id": "uuid-string"
}

Field	Tipe	Deskripsi
job_id	string	Pengidentifikasi unik untuk job yang dibuat. Gunakan Get Job Status untuk melihat hasil

Aturan Error / Validasi

Kondisi	Status HTTP	Pesan Error
Gambar bukan file PNG atau JPEG yang valid	400	"Invalid image file"
Nilai frame tidak diizinkan	400	"frame should be one of 4, 9, 16"
API key tidak valid	401	"Invalid API key"
Field hilang atau nilai enum tidak dikenal	422	Error validasi

Perilaku Job Async

Endpoint ini membuat job asynchronous. Endpoint akan segera mengembalikan job_id, dan pembuatan efek sebenarnya terjadi di latar belakang.

Metode Polling:

1. Simpan job_id yang diterima dari respons
2. Poll GET /public/v1/job/{job_id} untuk memeriksa status
3. Saat status menjadi Succeed, lihat hasil pada image_urls

Alur Status: Pending → Succeed atau Failed

Contoh Permintaan

cURL (tanpa gambar):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "frame=9" \
-F "background_color=white"

cURL (dengan gambar):

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