REST API · v1

API belgeleri

Portreleri asenkron bir API üzerinden gönderin, mevcut kredi bakiyenizi paylaşın ve her işi ve ücreti takip edin.

Uygulamanızı bir yapay zekâ rehberiyle bağlayın

Bu istemi ChatGPT, Claude, Cursor veya kullandığınız kod asistanına kopyalayın. Asistan önce teknoloji yığınızı soracak, ardından kimlik bilgilerini ayarlama, bakiye kontrolü, iş gönderme ve sonucu doğrulama adımlarında size rehberlik edecek.

Düz metni aç

API anahtarınızı yapay zekâyla paylaşmanız gerekmez. İstem, anahtarı kendi sunucu ortamınızda nasıl yapılandıracağınız konusunda size rehberlik eder.

İstemin tamamını oku / elle kopyala

# FAHR FACE API v1

Sen benim API entegrasyon asistanımsın. Benim dilimde, bu asenkron portre yaş tahmini API'sini projemle bütünleştirmeme yardımcı ol. Aşağıdaki sözleşmeye uy. Güncel belgelerde farklı bilgiler varsa uygulamayı değiştirmeden önce farkı açıkla. Uç nokta, SDK veya yanıt alanı uydurma.

Önce bana hangi dili kullandığımı, çerçevemi ve çalışma zamanı sürümünü; projenin yeni mi mevcut mu olduğunu; barındırma ve sunucu imkânlarını; CLI betiğine, arka uç entegrasyonuna veya web özelliğine ihtiyacım olup olmadığını sor. Projemi inceleyebiliyorsan önce yapısını, bağımlılıklarını ve kurallarını kontrol et. Her mesajda doğrulanabilir küçük bir adım için işletim sistemime uygun komutlar, dosya konumları, beklenen sonuçlar ve sorun giderme adımları sun. Devam etmeden önce geri bildirimimi bekle. Sıralama: kimlik bilgilerini yapılandır → ücretsiz bakiye kontrolü → yükleme uygulaması → işi kaydet ve sorgula → sonucu ve ücretlendirmeyi doğrula. Gerçekte uygulanmamış adımların başarıyla tamamlandığını asla söyleme.

Temel URL: https://fahrface.org. Belgeler: https://fahrface.org/developers; anahtar oluştur: https://fahrface.org/settings/apikeys; kredi yükle: https://fahrface.org/pricing. Benden küçük bütçeli, süreli bir anahtar oluşturmamı iste. Gerekli izinler: face-age:write, face-age:read, credits:read; kullanım geçmişi için yalnızca usage:read. Gizli anahtar yalnızca bir kez gösterilir. Gerçek gizli anahtarı yapay zekâ sohbetine yapıştırmamı asla isteme. Yalnızca sunucuda kullanılacak FAHRFACE_API_KEY ortam değişkenini kullan ve yerel gizli dosyaları sürüm denetiminden hariç tut. Gizli bilgileri kaynak koduna, günlüklere, tarayıcıya veya mobil koda koyma; VITE_ ya da NEXT_PUBLIC_ öneklerini kullanma. Web arayüzü, kendi arka uç vekil sunucum üzerinden istek göndermelidir; bu API tarayıcıdan CORS entegrasyonunu desteklemez.

Tüm uç noktalar https://fahrface.org adresini kullanır ve Authorization: Bearer <FAHRFACE_API_KEY> gerektirir. JSON yanıtları code, message ve data alanlarını içerir; başarılı yanıt için code=0 olmalıdır. POST isteği multipart/form-data biçimindedir ve tam olarak iki alan içerir: image (en fazla 5 MiB boyutunda, MIME türü gerçek dosya biçimiyle eşleşen tek bir JPEG, PNG veya WebP dosyası) ve consent=appearance-age-2026-10-21. Uzak görüntü URL'leri, JSON biçiminde görüntü verileri, toplu istekler veya ek alanlar kabul edilmez. FormData kullanırken, sınır bilgisini de içeren Content-Type başlığını HTTP istemcisinin ayarlamasına izin verin. Yükleme öncesinde gerçek kullanıcı; 18 yaşını doldurduğunu, fotoğrafın kendisine ait olduğunu ve işlenmesine izin verdiğini açıkça onaylamalıdır. Onay kutusunu önceden seçmeyin veya onay uydurmayın. Uç noktalar, kapsamlar ve örnek yanıt:

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

İstek tekilleştirme: Yeni iş oluşturmak için Idempotency-Key gerekir. Bu anahtar 16–128 ASCII harfinden, rakamdan, alt çizgiden veya kısa çizgiden oluşmalıdır (UUID uygundur). Her yeni ve bilinçli test için anahtarı bir kez oluşturun. İstek göndermeden önce anahtarın, orijinal dosyanın baytlarının, MIME türünün ve onayın eşleşmesini kalıcı olarak kaydedin. Aynı hesap, anahtar ve girdi, yeniden ücret alınmadan orijinal işi döndürür; aynı anahtarla farklı girdi gönderilirse HTTP 409 döner. Ağ zaman aşımı, yeniden deneme ve süreç yeniden başlatma durumlarında orijinal anahtarı ve dosyayı kullanın. Yeniden deneme döngüsü içinde asla UUID oluşturmayın. Başarısız bir işi aynı anahtarla yeniden göndermek yine aynı işi döndürür; yalnızca açıkça istenen yeni bir test için yeni anahtar oluşturun.

Asenkron akış: Yeni iş HTTP 202, yinelenen istek HTTP 200 döndürür. data.id değerini kaydedin. GET /api/v1/face-age/jobs/JOB_ID isteğini her 10–15 saniyede bir gönderin; Retry-After başlığına ve anahtarın istek sınırına uyun. queued, processing ve retrying tamamlanmamış durumları; succeeded ve failed ise son durumları belirtir. Başarılı yanıtta sayısal data.age (yıl) ve data.billingStatus değerlerini, başarısız yanıtta data.error değerini okuyun. HF'nin soğuk başlatmaları birkaç dakika sürebilir. Zaman aşımı süresi 20 dakikadır; etkin bir çalışan kiralaması sonuçlanmayı 4 dakika daha geciktirebilir, ardından planlanmış kurtarma işlemi devreye girer. İstemcinin bekleme zaman aşımına uğraması, sunucu işinin başarısız olduğu anlamına gelmez. İş kimliğini koruyun ve sorgulamaya devam edilmesine izin verin; ücretli yeni bir test oluşturmayın.

Ücretlendirme: Her API testi 1 kredi ayırır; başarılı olursa ücret alınır, son aşamada başarısız olursa ücret bir kez iade edilir. Web sitesi testleri de aynı cüzdandan 10 kredi kullanır. GET sorguları ücretsizdir ancak istek sınırlarına dahildir. Önce GET /api/v1/credits ile data.available değerini kontrol edin: bu değer ayrılmış kredileri zaten hesaba katmadığından data.reserved değerini tekrar çıkarmayın. Bakiye yetersizliği, geçersiz görseller veya sınırlar nedeniyle iş oluşturulmadan reddedilen istekler ücretlendirilmez. Hesap sınırı: sorgular dahil dakikada 60 kimliği doğrulanmış istek; tek tek anahtarların sınırı daha düşük olabilir. Hesap başına aynı anda en fazla iki API işi yürütülebilir; bir anahtara yalnızca tek iş izni verilmiş olabilir. Anahtar bütçeleri, ayrılmış ve başarıyla tahsil edilmiş ücretleri kapsar; iadeler bütçeyi serbest bırakır. İptal edilmiş veya süresi dolmuş anahtarlarla sorgulama yapılamaz. Kullanım kayıtlarında page/pageSize parametreleri desteklenir; pageSize en fazla 100 olabilir.

Hatalar: Yalnızca isteğin tamamlanıp tamamlanmadığına değil, HTTP durumuna ve message alanına bakın. 400 geçersiz istek/onay/istek tekilleştirme anahtarı; 401 geçersiz/süresi dolmuş/iptal edilmiş anahtar; 403 eksik kapsam; 402 yetersiz kredi; 404 bulunamayan iş veya farklı hesap; 409 çakışan girdi; 413 dosya boyutu sınırı aşıldı; 415 yanlış biçim; 429 hız, eşzamanlılık veya anahtar bütçesi sınırı; 503 hizmet kullanılamıyor anlamına gelir. 400/401/402/403/413/415 hatalarında, düşünmeden yeniden denemek yerine yapılandırmayı/girdiyi düzeltin. 409 hatasında orijinal girdiyi geri yükleyin; yalnızca bilinçli olarak yeni bir test başlatırken yeni anahtar kullanın. 429 hatasında message alanını inceleyin: hız/eşzamanlılık sınırı için Retry-After süresi kadar bekleyin; bütçe sınırı için ayarlama gerekir. Ağ hatalarını veya 503 yanıtlarını, POST isteğinin idempotency anahtarını koruyarak sınırlı sayıda ve artan bekleme aralıklarıyla yeniden deneyin. Sorgulama hatalarından sonra orijinal iş kimliğini koruyun.

Kabul testleri: Önce ücretsiz bakiye kontrolünü yapın. Gerçek bir yükleme öncesinde, uygun nitelikte ve sahibinin onay verdiği bir portreye sahip olduğumu doğrulayın ve kredi ayrılacağını açıklayın. İş oluşturma yanıtının bir iş kimliği döndürdüğünü, aynı girdi/anahtarla yinelenen isteğin aynı kimliği döndürdüğünü, sorgulamanın son duruma ulaştığını, başarılı yanıtın yaş tahmini içerdiğini ve yalnızca bir kez ücret alındığını doğrulayın; ayrıca sayfa yenileme/yeniden başlatma sonrasında sorgulamaya devam edilebildiğini kontrol edin. Gerçek bir API çağrısı için bakiye veya izin yoksa canlı entegrasyonun başarıyla tamamlandığını iddia etmeyin; yerel/mock doğrulama yapıldığını dürüstçe belirtin. Son olarak çalıştırma talimatlarını, ortam değişkenlerinin adlarını, değiştirilen dosyaları ve sorun giderme bilgilerini paylaşın. Gerçek sırları veya fotoğraf içeriklerini asla göstermeyin.

Gizlilik ve sınırlar: Fotoğraflar geçici olarak özel bir yerde saklanır, işlem tamamlandığında silinir; yaşam döngüsü için 24 saatlik yedek silme süresi uygulanır. Portreyi HF işler. Uygulamam görselleri veya anahtarları günlüklere yazmamalı ve geçici dosyaları temizlemelidir. Sonuçlar, fotoğraftaki görünüş yaşını tahmin eder; tıbbi tavsiye, kimlik doğrulama veya yaş kanıtı değildir. v1'de webhook geri çağrıları, uzak görüntü URL'leri veya toplu istek uç noktası yoktur; bunları varmış gibi göstermeyin. Önce teknoloji yığınımı ve dağıtım ortamımı sorarak başlayın, ardından ilk adımda bana rehberlik edin.

Ücretlendirme

API: başarıyla tamamlanan test başına 1 kredi. Web sitesi: test başına 10 kredi. Her ikisi de aynı kredi bakiyesini kullanır. API üzerinden iş oluşturulduğunda 1 kredi ayrılır; işin nihai olarak başarısız olması durumunda bu kredi bir kez iade edilir.

Gerekli izinle birlikte Authorization: Bearer gönderin. Aynı görsel baytlarıyla yaptığınız tekrar denemelerde aynı Idempotency-Key değerini kullanın. Bu anahtarı farklı girdilerle yeniden kullanmak HTTP 409 hatası verir. Sorgular kredi tüketmez.

Uç noktalar

HTTP	İzinler
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

İş oluştur

Tek bir görsel dosyası (JPEG, PNG veya WebP, en fazla 5 MB) ve aşağıdaki consent alanıyla multipart/form-data kullanın. Bu uç noktayı yalnızca kendi fotoğrafını gönderen ve buna onay veren yetişkinler kullanabilir. Uzak URL'ler ve ek parametreler kabul edilmez. Yalnızca yeni bir mantıksal test için yeni bir idempotency key oluşturun.

# Her yeni test için bir kez oluşturup kaydedin; tekrar denemelerde yalnızca aşağıdaki curl komutunu, ilk anahtar ve görselle çalıştırın.
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"
  }
}

Sonuçları sorgula

İş oluşturma isteği HTTP 202 ve bir iş kimliği döndürür. 10–15 saniyede bir sorgulayın. queued, processing ve retrying nihai olmayan durumlardır; succeeded ve failed nihai durumlardır. HF'nin uyanması birkaç dakika sürebilir. İşlerin tamamlanması için 20 dakika süre tanınır; etkin bir worker lease, nihai kurtarma işlemini dört dakikaya kadar geciktirebilir.

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

Hatalar ve limitler

Yanıtlar code/message/data yapısını kullanır. HTTP 400: geçersiz istek veya onay; 401: geçersiz/süresi dolmuş anahtar; 403: gerekli izin yok; 402: yetersiz kredi; 404: bulunamayan veya size ait olmayan iş; 409: girdi değişti; 413/415: geçersiz görsel boyutu/türü; 429: istek, eşzamanlılık veya bütçe limiti; 503: hizmet kullanılamıyor. Retry-After yönergesine uyun, aynı idempotency key değerini yeniden kullanın ve tekrar denemeden önce message alanını inceleyin.

Anahtarların süresi en geç bir yıl içinde dolar. Bütçeye ayrılmış ve başarıyla kullanılmış krediler dahildir; iadeler bütçeyi geri yükler. Hesapta dakikada en fazla 60 istek ve aynı anda en fazla iki etkin API işi yapılabilir.

Portreler özel bir depolama alanında geçici olarak saklanır ve işlem tamamlandıktan sonra silinir; ayrıca 24 saatlik otomatik silme süresi uygulanır. Fotoğrafı HF işler. Tahminler tıbbi tavsiye, kimlik doğrulama veya yaş kanıtı değildir.