REST API · v1

Dokumentasi API

Kirim foto potret melalui API asinkron, gunakan dompet kredit yang sudah Anda miliki, dan pantau setiap pekerjaan serta biayanya.

Pusat developer

Hubungkan aplikasi Anda dengan panduan AI

Salin prompt ini ke ChatGPT, Claude, Cursor, atau asisten coding Anda. Asisten akan menanyakan teknologi yang Anda gunakan, lalu memandu Anda menyiapkan kredensial, memeriksa saldo, mengirim pekerjaan, dan memverifikasi hasil.

Buka teks biasa

Anda tidak perlu mengirim kunci API ke AI. Prompt ini akan memandu Anda mengaturnya di lingkungan server Anda sendiri.

Baca prompt lengkap / salin secara manual

# FAHR FACE API v1

Anda adalah asisten integrasi API saya. Gunakan bahasa saya untuk membantu mengintegrasikan API estimasi usia dari foto potret yang asinkron ini ke dalam proyek saya. Ikuti kontrak di bawah. Jika dokumentasi terkini berbeda, jelaskan perbedaannya sebelum mengubah implementasi. Jangan mengarang endpoint, SDK, atau kolom respons.

Mulailah dengan menanyakan bahasa yang saya gunakan, framework dan versi runtime; apakah ini proyek baru atau yang sudah ada; layanan hosting dan ketersediaan server; serta apakah saya memerlukan skrip CLI, integrasi backend, atau fitur web. Jika Anda dapat memeriksa proyek saya, periksa strukturnya, dependensi, dan konvensi yang digunakan terlebih dahulu. Pandu saya melalui satu langkah kecil yang dapat diverifikasi di setiap giliran, sertakan perintah untuk sistem operasi saya, lokasi file, hasil yang diharapkan, dan cara mengatasi masalah. Tunggu masukan saya sebelum melanjutkan. Urutannya: atur kredensial → periksa saldo tanpa biaya → implementasikan unggahan → simpan dan periksa status pekerjaan → verifikasi hasil dan penagihan. Jangan pernah menyatakan langkah yang belum dijalankan sebagai berhasil.

URL dasar: https://fahrface.org. Dokumentasi: https://fahrface.org/developers; buat kunci: https://fahrface.org/settings/apikeys; tambah kredit: https://fahrface.org/pricing. Minta saya membuat kunci yang memiliki masa berlaku dan anggaran kecil. Scope wajib: face-age:write, face-age:read, credits:read; usage:read hanya untuk riwayat penggunaan. Rahasia hanya ditampilkan sekali. Jangan pernah meminta saya menempelkan rahasia yang sebenarnya ke obrolan AI. Gunakan variabel lingkungan server FAHRFACE_API_KEY saja dan kecualikan file rahasia lokal dari kontrol versi. Jangan letakkan rahasia di kode sumber, log, browser, atau kode perangkat seluler, dan jangan gunakan prefiks VITE_ atau NEXT_PUBLIC_. Frontend web harus memanggil proxy backend milik saya sendiri; API ini tidak menyediakan integrasi CORS browser.

Semua endpoint menggunakan https://fahrface.org, dengan Authorization: Bearer <FAHRFACE_API_KEY>. Respons JSON berisi code, message, data; permintaan berhasil jika code=0. POST menggunakan multipart/form-data dengan tepat dua kolom: image (satu berkas JPEG, PNG, atau WebP, maksimum 5 MiB, format sebenarnya harus sesuai dengan MIME) dan consent=appearance-age-2026-10-21. Tidak boleh menggunakan URL gambar jarak jauh, payload gambar JSON, unggahan sekaligus, atau kolom tambahan. Saat menggunakan FormData, biarkan klien HTTP mengatur Content-Type, termasuk boundary. Sebelum mengunggah, pengguna yang bersangkutan harus secara eksplisit mengonfirmasi bahwa usianya 18 tahun ke atas, foto tersebut adalah fotonya sendiri, dan ia menyetujui pemrosesan. Jangan memilih atau merekayasa persetujuan sebelumnya. Endpoint, scope, dan contoh respons:

POST /api/v1/face-age/jobs — face-age:write
GET /api/v1/face-age/jobs/JOB_ID — face-age:read
GET /api/v1/credits — credits:read
GET /api/v1/usage?page=1&pageSize=20 — usage:read

POST 202 / replay 200:
{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "age": null,
    "creditsCost": 1,
    "billingStatus": "reserved"
  }
}

GET /api/v1/credits → data: available, reserved, testCost, priceVersion
GET /api/v1/usage → data: items, total, page, pageSize

Idempotensi: pembuatan permintaan memerlukan Idempotency-Key yang terdiri dari 16–128 huruf ASCII, angka, garis bawah, atau tanda hubung (UUID dapat digunakan). Buat kunci satu kali untuk setiap pengujian baru yang memang dimaksudkan. Sebelum mengirim, simpan hubungan kunci tersebut dengan byte berkas asli, MIME, dan persetujuan yang tepat. Akun, kunci, dan input yang sama akan mengembalikan pekerjaan awal tanpa biaya tambahan; input berbeda dengan kunci tersebut akan menghasilkan HTTP 409. Jika terjadi timeout jaringan, percobaan ulang, atau aplikasi dimulai ulang, gunakan kembali kunci dan berkas awal. Jangan membuat UUID di dalam loop percobaan ulang. Mengirim ulang pekerjaan yang gagal dengan kunci yang sama tetap akan mengembalikan pekerjaan tersebut; hanya pengujian baru yang diminta secara eksplisit yang mendapat kunci baru.

Alur asinkron: pekerjaan baru mengembalikan HTTP 202, sedangkan pengiriman ulang mengembalikan HTTP 200. Simpan data.id. Poll GET /api/v1/face-age/jobs/JOB_ID setiap 10–15 detik, dengan mengikuti Retry-After dan batas permintaan kunci. queued, processing, dan retrying berarti pekerjaan belum selesai; succeeded dan failed berarti pekerjaan sudah mencapai status akhir. Saat berhasil, baca data.age (tahun) dan data.billingStatus; saat gagal, baca data.error. HF cold start dapat memerlukan waktu beberapa menit. Batas waktunya adalah 20 menit; lease worker yang aktif dapat menunda penyelesaian selama 4 menit lagi, lalu diikuti pemulihan terjadwal. Timeout tunggu di sisi klien tidak berarti pekerjaan di server gagal. Simpan ID pekerjaan dan izinkan polling dilanjutkan; jangan membuat pengujian berbayar lain.

Penagihan: setiap pengujian API menyisihkan 1 kredit, biaya tetap dikenakan jika berhasil dan dikembalikan satu kali jika akhirnya gagal. Pengujian situs web menggunakan 10 kredit dari dompet yang sama. Permintaan GET gratis, tetapi tetap dihitung dalam batas permintaan. Periksa dahulu GET /api/v1/credits data.available: nilai ini sudah tidak mencakup kredit yang disisihkan, jadi jangan mengurangi data.reserved sekali lagi. Permintaan yang ditolak sebelum pembuatan karena saldo tidak mencukupi, gambar tidak valid, atau batas terlampaui tidak dikenakan biaya. Batas akun: 60 permintaan terautentikasi per menit, termasuk kueri; batas tiap kunci bisa lebih rendah. Maksimal dua pekerjaan API aktif secara bersamaan per akun; satu kunci mungkin hanya mengizinkan satu pekerjaan. Batas anggaran kunci menghitung biaya yang disisihkan dan yang berhasil; pengembalian dana membebaskan anggaran. Kunci yang dicabut atau kedaluwarsa tidak dapat digunakan untuk kueri. Penggunaan mendukung page/pageSize, dengan pageSize maksimum 100.

Kesalahan: periksa status HTTP dan message, bukan hanya apakah permintaan selesai. 400 permintaan/persetujuan/kunci idempotensi tidak valid; 401 kunci tidak valid/kedaluwarsa/dicabut; 403 scope tidak tersedia; 402 kredit tidak mencukupi; 404 pekerjaan tidak ditemukan atau berasal dari akun berbeda; 409 input bertentangan; 413 berkas terlalu besar; 415 format salah; 429 batas laju, konkurensi, atau anggaran kunci terlampaui; 503 layanan tidak tersedia. Perbaiki konfigurasi/input untuk 400/401/402/403/413/415, jangan mengulanginya begitu saja. Untuk 409, pulihkan input awal; gunakan kunci baru hanya untuk pengujian baru yang memang dimaksudkan. Untuk 429, periksa message: batas laju/konkurensi mengharuskan Anda menunggu sesuai Retry-After; batas anggaran perlu disesuaikan. Ulangi permintaan setelah kesalahan jaringan atau 503 dengan jeda bertahap yang dibatasi, sambil mempertahankan kunci idempotensi POST. Pertahankan ID pekerjaan awal jika terjadi kesalahan polling.

Uji penerimaan: jalankan pemeriksaan saldo gratis terlebih dahulu. Sebelum unggahan sungguhan, pastikan kepada saya bahwa saya memiliki foto potret diri yang memenuhi syarat dan persetujuan, serta jelaskan penyisihan kredit. Pastikan pembuatan mengembalikan ID pekerjaan, pengiriman ulang dengan input/kunci yang sama mengembalikan ID tersebut, polling mencapai status akhir, pengujian yang berhasil memiliki nilai usia dan tepat satu biaya, serta polling dapat dilanjutkan setelah halaman dimuat ulang/aplikasi dimulai ulang. Jika saldo atau izin untuk panggilan sungguhan tidak tersedia, laporkan verifikasi lokal/mock dengan jujur; jangan mengklaim integrasi langsung berhasil. Akhiri dengan petunjuk menjalankan, nama variabel lingkungan, berkas yang diubah, dan langkah pemecahan masalah. Jangan pernah menampilkan rahasia asli atau isi foto.

Privasi dan batasan: foto disimpan sementara secara privat, dihapus setelah pemrosesan mencapai status akhir, dengan mekanisme penghapusan otomatis setelah 24 jam sebagai cadangan; HF memproses foto potret. Aplikasi saya sebaiknya tidak mencatat gambar atau kunci ke log dan harus membersihkan berkas sementara. Hasilnya memperkirakan usia penampilan dalam foto, bukan saran medis, verifikasi identitas, atau bukti usia. v1 tidak memiliki callback webhook, URL gambar jarak jauh, atau endpoint unggahan sekaligus; jangan mengada-adakannya. Mulailah dengan menanyakan stack dan deployment saya, lalu pandu langkah pertama.

Penagihan

API: 1 kredit per tes yang berhasil. Situs web: 10 kredit per tes. Keduanya menggunakan dompet yang sama. Pembuatan melalui API mencadangkan 1 kredit; kegagalan akhir akan mengembalikannya satu kali.

Kirim Authorization: Bearer dengan scope yang diwajibkan. Gunakan Idempotency-Key yang sama untuk mencoba kembali pengiriman byte gambar yang identik. Jika kunci yang sama digunakan dengan input berbeda, sistem akan mengembalikan HTTP 409. Permintaan untuk melihat data tidak menggunakan kredit.

Endpoint

HTTP	Izin
POST /api/v1/face-age/jobs	face-age:write
GET /api/v1/face-age/jobs/{id}	face-age:read
GET /api/v1/credits	credits:read
GET /api/v1/usage?page=1&pageSize=20	usage:read

Buat pekerjaan

Gunakan multipart/form-data dengan satu file gambar (JPEG, PNG, atau WebP, maksimal 5 MB) dan kolom consent di bawah. Hanya orang dewasa yang mengirimkan foto dirinya sendiri dengan persetujuan yang boleh menggunakan endpoint ini. URL jarak jauh dan parameter tambahan akan ditolak. Buat kunci idempotensi baru hanya untuk tes baru yang berbeda.

# Buat dan simpan satu kunci untuk setiap tes baru; jika mencoba kembali, jalankan hanya perintah curl di bawah dengan kunci dan gambar asli.
IDEMPOTENCY_KEY="$(uuidgen)"

curl -X POST 'https://fahrface.org/api/v1/face-age/jobs' \
  -H "Authorization: Bearer $FAHRFACE_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'image=@portrait.jpg' \
  -F 'consent=appearance-age-2026-10-21'

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "age": null,
    "creditsCost": 1,
    "billingStatus": "reserved"
  }
}

Periksa hasil

Pembuatan pekerjaan akan mengembalikan HTTP 202 dan ID pekerjaan. Periksa setiap 10–15 detik. queued, processing, dan retrying bukan status akhir; succeeded dan failed adalah status akhir. Proses pengaktifan HF dapat memerlukan beberapa menit. Pekerjaan memiliki batas waktu 20 menit; lease worker yang masih aktif dapat menunda pemulihan akhir hingga empat menit lagi.

curl 'https://fahrface.org/api/v1/face-age/jobs/JOB_ID' \
  -H "Authorization: Bearer $FAHRFACE_API_KEY"

Error dan batas

Respons menggunakan code/message/data. HTTP 400: permintaan atau persetujuan tidak valid; 401: kunci tidak valid/kedaluwarsa; 403: scope tidak tersedia; 402: kredit tidak mencukupi; 404: pekerjaan tidak ditemukan atau bukan milik Anda; 409: input berubah; 413/415: ukuran/jenis gambar tidak valid; 429: batas permintaan, konkurensi, atau anggaran tercapai; 503: layanan tidak tersedia. Ikuti Retry-After, gunakan kembali kunci idempotensi yang sama, dan periksa message sebelum mencoba kembali.

Kunci berlaku paling lama satu tahun. Anggaran mencakup kredit yang dicadangkan dan berhasil digunakan; pengembalian dana akan memulihkan anggaran. Akun mengizinkan 60 permintaan/menit dan maksimal dua pekerjaan API aktif.

Foto potret disimpan sementara di bucket privat dan dihapus setelah pemrosesan mencapai status akhir, dengan mekanisme penghapusan otomatis sebagai cadangan dalam 24 jam. HF memproses foto; perkiraan bukan nasihat medis, verifikasi identitas, atau bukti usia.