REST API · v1

API-dokumentation

Indsend portrætter via et asynkront API, brug din eksisterende kreditkonto, og følg alle job og betalinger.

Forbind din app med en AI-guide

Kopiér denne prompt ind i ChatGPT, Claude, Cursor eller din kodeassistent. Den spørger til din teknologistak og guider dig derefter gennem legitimationsoplysninger, tjek af saldo, indsendelse af job og bekræftelse af resultatet.

Åbn almindelig tekst

Du behøver ikke sende din API-nøgle til AI'en. Prompten guider dig til at konfigurere den i dit eget servermiljø.

Læs hele prompten / kopiér manuelt

# FAHR FACE API v1

Du er min API-integrationsassistent. Hjælp mig på mit sprog med at integrere dette asynkrone API til estimering af udseendealder ud fra portrætter i mit projekt. Følg specifikationerne nedenfor. Hvis den aktuelle dokumentation afviger, skal du forklare forskellen, før du ændrer implementeringen. Opfind ikke slutpunkter, SDK'er eller svarfelter.

Start med at spørge om mit sprog, framework og runtime-version; om det er et nyt eller eksisterende projekt; om hosting og server er tilgængelige; og om jeg har brug for et CLI-script, en backend-integration eller en webfunktion. Hvis du kan undersøge mit projekt, skal du først tjekke dets struktur, afhængigheder og konventioner. Før mig gennem ét lille, verificerbart trin ad gangen med kommandoer til mit operativsystem, filplaceringer, forventede resultater og fejlfinding. Vent på min tilbagemelding, før du fortsætter. Følg denne rækkefølge: konfigurér legitimationsoplysninger → gratis saldotjek → implementér upload → gem og afvent et job → bekræft resultat og betaling. Påstå aldrig, at trin, du ikke har udført, er lykkedes.

Basis-URL: https://fahrface.org. Dokumentation: https://fahrface.org/developers; opret nøgler: https://fahrface.org/settings/apikeys; køb flere kreditter: https://fahrface.org/pricing. Bed mig om at oprette en nøgle med en udløbsdato og et lille budget. Påkrævede scopes: face-age:write, face-age:read, credits:read; usage:read kun til brugshistorik. Hemmeligheden vises én gang. Bed mig aldrig om at indsætte den rigtige hemmelighed i en AI-chat. Brug en server-only-miljøvariabel med navnet FAHRFACE_API_KEY, og sørg for, at lokale filer med hemmeligheder ikke versionsstyres. Læg ikke hemmeligheder i kildekode, logfiler, browser- eller mobilkode, og brug ikke præfikserne VITE_ eller NEXT_PUBLIC_. En webfrontend skal kalde min egen backend-proxy; dette API understøtter ikke CORS-integration i browseren.

Alle endpoints bruger https://fahrface.org med Authorization: Bearer <FAHRFACE_API_KEY>. JSON-svar indeholder code, message, data; succes kræver code=0. POST er multipart/form-data med præcis to felter: image (én JPEG-, PNG- eller WebP-fil, højst 5 MiB, hvor det faktiske format skal stemme overens med MIME-typen) og consent=appearance-age-2026-10-21. Ingen eksterne billed-URL'er, billeddata i JSON, batches eller ekstra felter. Når du bruger FormData, skal HTTP-klienten selv angive Content-Type inklusive boundary. Før upload skal den faktiske bruger udtrykkeligt bekræfte, at vedkommende er fyldt 18 år, at billedet er af vedkommende selv, og at vedkommende giver samtykke til behandlingen. Forudvælg eller fabriker ikke samtykke. Endpoints, scopes og eksempelsvar:

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

Idempotens: Oprettelse kræver Idempotency-Key med 16–128 ASCII-bogstaver, tal, understregningstegn eller bindestreger (en UUID kan bruges). Generér nøglen én gang for hver bevidst ny test. Gem tilknytningen mellem nøglen og de præcise originale filbytes, MIME-type og samtykke, før du sender. Samme konto, nøgle og input returnerer det oprindelige job uden en ny opkrævning; et andet input med samme nøgle returnerer HTTP 409. Ved netværkstimeout, gentagne forsøg og genstart af processen skal du genbruge den oprindelige nøgle og fil. Generér aldrig en UUID i en løkke med gentagne forsøg. Hvis du genafspiller et fejlet job med samme nøgle, får du stadig det samme job; kun en udtrykkeligt anmodet ny test får en ny nøgle.

Asynkront forløb: Et nyt job returnerer HTTP 202, og en genafspilning returnerer HTTP 200. Gem data.id. Afstem med GET /api/v1/face-age/jobs/JOB_ID hvert 10.–15. sekund, og overhold Retry-After og grænsen for antal anmodninger med nøglen. queued, processing og retrying betyder, at jobbet ikke er afsluttet; succeeded og failed er endelige tilstande. Ved succes skal du aflæse det numeriske data.age (år) og data.billingStatus; ved fejl skal du aflæse data.error. HF-koldstarter kan tage flere minutter. Fristen er 20 minutter; en aktiv worker lease kan forsinke afregningen med yderligere 4 minutter, hvorefter planlagt genoprettelse finder sted. Hvis klientens ventetid udløber, betyder det ikke, at serverjobbet er fejlet. Behold job-id'et, så afstemningen kan genoptages; opret ikke endnu en betalt test.

Betaling: Hver API-test reserverer 1 credit. Beløbet opkræves ved succes og refunderes én gang ved endelig fejl. Test på websitet koster 10 credits fra samme saldo. GET-forespørgsler er gratis, men tæller med i grænsen for antal anmodninger. Tjek først GET /api/v1/credits data.available: beløbet tager allerede højde for reservationer, så træk ikke data.reserved fra igen. Anmodninger, der afvises før oprettelse på grund af utilstrækkelig saldo, ugyldige billeder eller overskredne grænser, opkræves ikke. Kontogrænse: 60 godkendte anmodninger i minuttet, inklusive forespørgsler; individuelle nøgler kan have lavere grænser. Der kan højst være to samtidige API-jobs pr. konto; en nøgle tillader muligvis kun ét. Nøglebudgetter tæller reserverede beløb og gennemførte opkrævninger med; refunderinger frigiver budget. Tilbagekaldte eller udløbne nøgler kan ikke bruges til forespørgsler. Brug af API'et understøtter page/pageSize; maksimal pageSize er 100.

Fejl: Tjek HTTP-status og message, ikke kun om anmodningen blev gennemført. 400 ugyldig anmodning/samtykke/idempotensnøgle; 401 ugyldig/udløbet/tilbagekaldt nøgle; 403 manglende scope; 402 utilstrækkelige credits; 404 manglende job eller en anden konto; 409 inputkonflikt; 413 for stor fil; 415 forkert format; 429 grænse for hastighed, samtidighed eller nøglebudget; 503 tjenesten er utilgængelig. Ret konfiguration eller input ved 400/401/402/403/413/415 i stedet for at prøve igen uden omtanke. Ved 409 skal du gendanne det oprindelige input; brug kun en ny nøgle til en bevidst ny test. Ved 429 skal du tjekke message: Vent i henhold til Retry-After ved grænser for hastighed eller samtidighed; en budgetgrænse kræver en justering. Prøv igen efter netværksfejl eller 503 med begrænset backoff, og behold POST-anmodningens idempotensnøgle. Behold det oprindelige job-id efter fejl under afstemning.

Godkendelse: Kør først det gratis saldotjek. Før en rigtig upload skal du bekræfte med mig, at jeg har et egnet portræt af mig selv, at jeg giver samtykke, og forklare reservationen af credits. Kontrollér, at oprettelsen returnerer et job-id, at en genafspilning med samme input og nøgle returnerer samme id, at afstemningen når en endelig tilstand, at succes indeholder en alder og præcis én opkrævning, og at afstemningen kan genoptages efter opdatering eller genstart. Hvis der mangler saldo eller tilladelse til et rigtigt API-kald, skal du ærligt oplyse, at kontrollen kun er udført lokalt eller med en mock; påstå ikke, at live-integrationen er godkendt. Afslut med instruktioner til at køre løsningen, navne på miljøvariabler, ændrede filer og fejlfinding. Vis aldrig rigtige hemmeligheder eller indholdet af billeder.

Privatliv og begrænsninger: Billeder opbevares midlertidigt og privat og slettes efter den endelige behandling, med en reserveordning, der sletter dem efter 24 timer; HF behandler portrættet. Min app bør undgå at logge billeder eller nøgler og rydde op i midlertidige filer. Resultaterne anslår, hvor gammel en person ser ud på et foto, og er ikke medicinsk rådgivning, identitetsbekræftelse eller dokumentation for alder. v1 har ingen webhook-callbacks, eksterne billed-URL'er eller batch-endpoint; opfind dem ikke. Begynd med at spørge til mit teknologistak og min udrulning, og hjælp mig derefter med det første trin.

Betaling

API: 1 kredit pr. gennemført test. Website: 10 kreditter pr. test. Begge bruger samme kreditkonto. Oprettelse via API reserverer 1 kredit; ved en endelig fejl tilbageføres den én gang.

Send Authorization: Bearer med det påkrævede scope. Brug samme Idempotency-Key ved gentagelser af identiske billeddata. Hvis nøglen genbruges med et andet input, returneres HTTP 409. Forespørgsler bruger ikke kreditter.

Slutpunkter

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

Opret et job

Brug multipart/form-data med én billedfil (JPEG, PNG eller WebP, op til 5 MB) og samtykkefeltet nedenfor. Kun voksne, der indsender deres eget foto med samtykke, må bruge dette slutpunkt. Eksterne URL'er og ekstra parametre afvises. Generér kun en ny idempotency-nøgle til en ny logisk test.

# Generér og gem én nøgle pr. ny test; ved gentagelser skal du kun køre curl-kommandoen nedenfor med den oprindelige nøgle og det samme billede.
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"
  }
}

Hent resultater

Oprettelsen returnerer HTTP 202 og et job-id. Afvent svar hvert 10.–15. sekund. queued, processing og retrying er ikke-afsluttende tilstande; succeeded og failed er afsluttende. HF-opstart kan tage flere minutter. Job har en frist på 20 minutter; en aktiv worker-lease kan forsinke den endelige genopretning med op til yderligere fire minutter.

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

Fejl og grænser

Svar bruger code/message/data. HTTP 400: ugyldig anmodning eller manglende samtykke; 401: ugyldig/udløbet nøgle; 403: manglende scope; 402: utilstrækkelige kreditter; 404: job mangler eller tilhører ikke dig; 409: ændret input; 413/415: ugyldig billedstørrelse/-type; 429: grænse for anmodninger, samtidighed eller budget; 503: utilgængelig. Følg Retry-After, genbrug den samme idempotency-nøgle, og gennemgå message, før du prøver igen.

Nøgler udløber inden for et år. Budgetter omfatter reserverede og brugte kreditter; tilbagebetalinger gendanner budgettet. Kontoen tillader 60 anmodninger pr. minut og højst to aktive API-job.

Portrætter opbevares midlertidigt i en privat bucket og slettes efter afsluttet behandling med en automatisk reserveprocedure efter 24 timer. HF behandler fotoet; estimater er ikke lægelig rådgivning, identitetsbekræftelse eller bevis på alder.