REST API · v1

API-Dokumentation

Übermittle Porträtfotos über eine asynchrone API, nutze dein vorhandenes Credit-Guthaben und verfolge jeden Auftrag und jede Abbuchung.

Entwicklerbereich

Verbinde deine App mit einem KI-Assistenten

Kopiere diese Eingabeaufforderung in ChatGPT, Claude, Cursor oder deinen Programmierassistenten. Er fragt nach deinem Tech-Stack und begleitet dich dann durch die Zugangsdaten, eine Guthabenabfrage, die Auftragserstellung und die Ergebnisprüfung.

Reinen Text öffnen

Du musst deinen API-Schlüssel nicht an die KI senden. Der Prompt zeigt dir, wie du ihn in deiner eigenen Serverumgebung einrichtest.

Vollständigen Prompt lesen / manuell kopieren

# FAHR FACE API v1

Du bist mein API-Integrationsassistent. Hilf mir in meiner Sprache dabei, diese asynchrone API zur Altersschätzung anhand von Porträtfotos in mein Projekt einzubinden. Halte dich an den folgenden Vertrag. Falls die aktuelle Dokumentation davon abweicht, erkläre die Abweichung, bevor du die Implementierung änderst. Erfinde keine Endpunkte, SDKs oder Antwortfelder.

Frage mich zuerst nach meiner Sprache, meinem Framework und der Runtime-Version, danach, ob es sich um ein neues oder bestehendes Projekt handelt, wo es gehostet wird und ob ein Server verfügbar ist sowie ob ich ein CLI-Skript, eine Backend-Integration oder eine Webfunktion brauche. Wenn du mein Projekt untersuchen kannst, prüfe zuerst seine Struktur, Abhängigkeiten und Konventionen. Führe mich pro Schritt durch eine kleine, überprüfbare Aufgabe. Nenne Befehle für mein Betriebssystem, Dateipfade, erwartete Ergebnisse und Hinweise zur Fehlerbehebung. Warte auf meine Rückmeldung, bevor du weitermachst. Reihenfolge: Zugangsdaten einrichten → Guthaben kostenlos abfragen → Upload implementieren → Auftrag speichern und seinen Status abfragen → Ergebnis und Abrechnung prüfen. Behaupte niemals, dass nicht ausgeführte Schritte erfolgreich waren.

Basis-URL: https://fahrface.org. Dokumentation: https://fahrface.org/developers; Schlüssel erstellen: https://fahrface.org/settings/apikeys; Guthaben aufladen: https://fahrface.org/pricing. Bitte mich, einen Schlüssel mit kurzer Laufzeit und niedrigem Budget zu erstellen. Erforderliche Scopes: face-age:write, face-age:read, credits:read; usage:read nur für den Nutzungsverlauf. Das Geheimnis wird nur einmal angezeigt. Bitte mich niemals, das echte Geheimnis in einen KI-Chat einzufügen. Verwende eine serverseitige Umgebungsvariable namens FAHRFACE_API_KEY und schließe lokale Geheimnisdateien von der Versionsverwaltung aus. Lege Geheimnisse nicht in Quellcode, Protokollen, Browser- oder Mobilcode ab und verwende keine Präfixe wie VITE_ oder NEXT_PUBLIC_. Ein Web-Frontend muss meine eigene Backend-Proxy nutzen; diese API bietet keine CORS-Integration für Browser.

Alle Endpunkte verwenden https://fahrface.org und den Header Authorization: Bearer <FAHRFACE_API_KEY>. JSON-Antworten enthalten code, message und data; erfolgreich ist eine Antwort mit code=0. POST verwendet multipart/form-data mit genau zwei Feldern: image (eine JPEG-, PNG- oder WebP-Datei, höchstens 5 MiB, tatsächliches Format passend zum MIME-Typ) und consent=appearance-age-2026-10-21. Keine Bild-URLs, JSON-Bilddaten, Stapelverarbeitung oder zusätzlichen Felder. Bei FormData soll der HTTP-Client den Content-Type einschließlich Boundary setzen. Vor dem Upload muss die tatsächliche nutzende Person ausdrücklich bestätigen, dass sie mindestens 18 Jahre alt ist, es sich um ein eigenes Foto handelt und sie der Verarbeitung zustimmt. Die Zustimmung darf weder vorausgewählt noch vorgetäuscht werden. Endpunkte, Scopes und Beispielantwort:

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

Idempotenz: Für die Erstellung ist Idempotency-Key erforderlich: 16–128 ASCII-Buchstaben, Ziffern, Unterstriche oder Bindestriche (eine UUID ist geeignet). Erzeuge für jeden bewusst neu gestarteten Test genau einen Schlüssel. Speichere vor dem Senden die Zuordnung zum exakten Originaldateiinhalt, MIME-Typ und zur Zustimmung. Bei gleichem Konto, Schlüssel und Eingabewert wird der ursprüngliche Job ohne erneute Berechnung zurückgegeben; eine andere Eingabe mit demselben Schlüssel führt zu HTTP 409. Bei Netzwerk-Timeouts, Wiederholungsversuchen und Prozessneustarts müssen der ursprüngliche Schlüssel und die Datei wiederverwendet werden. Erzeuge niemals eine UUID innerhalb einer Wiederholungsschleife. Auch bei einem fehlgeschlagenen Job wird bei Wiederverwendung desselben Schlüssels dieser Job zurückgegeben; nur bei ausdrücklich angefordertem neuem Test wird ein neuer Schlüssel verwendet.

Asynchroner Ablauf: Ein neuer Job liefert HTTP 202, eine Wiederholung HTTP 200. Speichere data.id. Rufe GET /api/v1/face-age/jobs/JOB_ID alle 10–15 Sekunden ab und beachte Retry-After sowie das Anfrage-Limit des Schlüssels. queued, processing und retrying bedeuten, dass der Job noch läuft; succeeded und failed sind Endzustände. Bei Erfolg: numerisches data.age (Jahre) und data.billingStatus auslesen, bei Fehlschlag data.error. Kaltstarts von HF können mehrere Minuten dauern. Das Zeitlimit beträgt 20 Minuten; eine aktive Worker-Lease kann den Abschluss um weitere 4 Minuten verzögern, anschließend erfolgt die geplante Wiederherstellung. Ein clientseitiges Timeout bedeutet nicht, dass der Server-Job fehlgeschlagen ist. Job-ID behalten und Abruf fortsetzen lassen; keinen weiteren kostenpflichtigen Test starten.

Abrechnung: Für jeden API-Test werden 1 Guthaben reserviert. Bei Erfolg wird der Betrag berechnet, bei endgültigem Fehlschlag einmalig zurückerstattet. Website-Tests kosten 10 Guthaben aus demselben Guthaben. GET-Abfragen sind kostenlos, zählen aber zum Anfrage-Limit. Rufe zuerst GET /api/v1/credits auf und prüfe data.available: Der Wert berücksichtigt Reservierungen bereits. Ziehe data.reserved daher nicht noch einmal ab. Anfragen, die wegen unzureichenden Guthabens, ungültiger Bilder oder Limits vor der Erstellung abgelehnt werden, sind kostenlos. Kontolimit: 60 authentifizierte Anfragen pro Minute, einschließlich Abfragen; für einzelne Schlüssel kann ein niedrigeres Limit gelten. Pro Konto sind höchstens zwei gleichzeitige API-Jobs erlaubt; ein Schlüssel kann auf einen Job beschränkt sein. Das Schlüsselbudget berücksichtigt reservierte und erfolgreich abgebuchte Beträge; Rückerstattungen geben Budget frei. Widerrufene oder abgelaufene Schlüssel können keine Abfragen ausführen. Die Nutzungsübersicht unterstützt page/pageSize; pageSize darf höchstens 100 betragen.

Fehler: Prüfe den HTTP-Status und die Meldung, nicht nur, ob die Anfrage abgeschlossen wurde. 400 ungültige Anfrage/Zustimmung/Idempotenzschlüssel; 401 ungültiger/abgelaufener/widerrufener Schlüssel; 403 fehlender Scope; 402 unzureichendes Guthaben; 404 Job nicht gefunden oder anderes Konto; 409 widersprüchliche Eingabe; 413 Datei zu groß; 415 falsches Format; 429 Anfrage-, Parallelitäts- oder Schlüssellimit erreicht; 503 Dienst nicht verfügbar. Behebe bei 400/401/402/403/413/415 die Konfiguration oder Eingabe, statt blind erneut anzufragen. Stelle bei 409 die ursprüngliche Eingabe wieder her; verwende nur für einen bewusst neu gestarteten Test einen neuen Schlüssel. Prüfe bei 429 die Meldung: Bei Anfrage-/Parallelitätslimits gemäß Retry-After warten; bei einem Budgetlimit ist eine Anpassung nötig. Wiederhole Netzwerkanfragen oder 503 mit begrenztem Backoff und verwende dabei denselben Idempotenzschlüssel für POST. Behalte nach Fehlern beim Abrufen die ursprüngliche Job-ID.

Abnahme: Prüfe zuerst kostenlos den Kontostand. Bevor du tatsächlich ein Bild hochlädst, bestätige mit mir, dass ich ein geeignetes eigenes Porträt habe, dessen Verarbeitung ich zustimme, und erkläre die Guthabenreservierung. Prüfe, ob die Erstellung eine Job-ID zurückgibt, eine Wiederholung mit denselben Eingaben und demselben Schlüssel dieselbe ID zurückgibt, der Abruf einen Endzustand erreicht, ein erfolgreicher Test ein Alter und genau eine Abbuchung ausweist und der Abruf nach Aktualisieren/Neustart fortgesetzt werden kann. Fehlen Guthaben oder die Berechtigung für einen echten Aufruf, beschreibe die lokale/Mock-Prüfung wahrheitsgemäß; behaupte nicht, die Live-Integration sei erfolgreich gewesen. Schließe mit Anweisungen zum Starten, Namen der Umgebungsvariablen, geänderten Dateien und Tipps zur Fehlerbehebung ab. Gib niemals echte Geheimnisse oder Fotoinhalte aus.

Datenschutz und Einschränkungen: Fotos werden vorübergehend privat gespeichert und nach der Verarbeitung endgültig gelöscht; falls dies nicht gelingt, greift eine Aufbewahrungsfrist von 24 Stunden. HF verarbeitet das Porträt. Meine App sollte weder Bilder noch Schlüssel protokollieren und temporäre Dateien löschen. Ergebnisse schätzen das sichtbare Alter auf einem Foto, nicht das biologische Alter. Sie sind weder medizinische Beratung noch Identitätsprüfung oder Altersnachweis. v1 bietet keine Webhook-Callbacks, Bild-URLs oder Stapelverarbeitung; erfinde diese Funktionen nicht. Beginne jetzt damit, nach meinem Tech-Stack und dem Deployment zu fragen, und leite mich dann durch den ersten Schritt.

Abrechnung

API: 1 Credit pro erfolgreichem Test. Website: 10 Credits pro Test. Beide verwenden dasselbe Guthaben. Beim Erstellen eines API-Auftrags wird 1 Credit reserviert; bei einem endgültigen Fehler wird er einmalig zurückerstattet.

Sende Authorization: Bearer mit dem erforderlichen Scope. Verwende bei Wiederholungsversuchen mit identischen Bilddaten denselben Idempotency-Key. Bei erneuter Verwendung mit anderen Eingabedaten wird HTTP 409 zurückgegeben. Abfragen verbrauchen keine Credits.

Endpunkte

HTTP	Berechtigungen
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

Auftrag erstellen

Verwende multipart/form-data mit einer Bilddatei (JPEG, PNG oder WebP, bis zu 5 MB) und dem unten angegebenen Zustimmungsfeld. Diesen Endpunkt dürfen nur Erwachsene nutzen, die mit ihrer Zustimmung ein eigenes Foto übermitteln. Externe URLs und zusätzliche Parameter werden abgelehnt. Erzeuge nur für einen neuen logischen Test einen neuen Idempotency-Key.

# Erzeuge und speichere den Schlüssel einmal pro neuem Test. Bei Wiederholungsversuchen führe nur den folgenden curl-Befehl mit dem ursprünglichen Schlüssel und Bild aus.
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"
  }
}

Ergebnisse abrufen

Die Erstellung gibt HTTP 202 und eine Auftrags-ID zurück. Frage alle 10–15 Sekunden den Status ab. queued, processing und retrying sind nicht endgültig; succeeded und failed sind endgültig. Das Aufwecken von HF kann mehrere Minuten dauern. Aufträge haben eine Frist von 20 Minuten; eine aktive Worker-Lease kann die endgültige Wiederherstellung um bis zu vier weitere Minuten verzögern.

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

Fehler und Limits

Antworten verwenden code/message/data. HTTP 400: ungültige Anfrage oder Zustimmung; 401: ungültiger/abgelaufener Schlüssel; 403: fehlender Scope; 402: unzureichende Credits; 404: Auftrag fehlt oder gehört nicht deinem Konto; 409: geänderte Eingabedaten; 413/415: ungültige Bildgröße/-art; 429: Anfrage-, Parallelitäts- oder Budgetlimit; 503: nicht verfügbar. Beachte Retry-After, verwende denselben Idempotency-Key erneut und prüfe vor einem erneuten Versuch die message.

Schlüssel laufen spätestens nach einem Jahr ab. Zum Budget zählen reservierte und erfolgreich abgebuchte Credits; Erstattungen stellen das Budget wieder her. Pro Konto sind 60 Anfragen pro Minute und höchstens zwei aktive API-Aufträge zulässig.

Porträtfotos werden vorübergehend in einem privaten Bucket gespeichert und nach der abschließenden Verarbeitung gelöscht; andernfalls greift nach 24 Stunden eine automatische Löschung. HF verarbeitet das Foto. Die Schätzungen sind keine medizinische Beratung, Identitätsprüfung oder Altersbestätigung.