REST API · v1

API-dokumentasjon

Send inn portrettbilder via et asynkront API, bruk den eksisterende kredittsaldoen din, og følg med på alle jobber og belastninger.

Utviklersenter

Koble appen din til en AI-guide

Kopier denne ledeteksten til ChatGPT, Claude, Cursor eller kodeassistenten din. Den spør om teknologistakken din og veileder deg deretter gjennom oppsett av påloggingsinformasjon, kontroll av saldo, innsending av en jobb og bekreftelse av resultatet.

Åpne som ren tekst

Du trenger ikke å sende API-nøkkelen din til AI-en. Ledeteksten viser deg hvordan du konfigurerer den i ditt eget servermiljø.

Les hele ledeteksten / kopier manuelt

# FAHR FACE API v1

Du er min API-integrasjonsassistent. Hjelp meg på språket mitt med å integrere dette asynkrone API-et for estimering av utseendealder fra portrettbilder i prosjektet mitt. Følg kontrakten nedenfor. Hvis den gjeldende dokumentasjonen avviker, forklar forskjellen før du endrer implementeringen. Ikke finn på endepunkter, SDK-er eller responsfelter.

Begynn med å spørre om språk, rammeverk og kjøretidsversjon, om dette er et nytt eller eksisterende prosjekt, om hosting og server er tilgjengelig, og om jeg trenger et CLI-skript, en backend-integrasjon eller en webfunksjon. Hvis du kan undersøke prosjektet mitt, bør du først sjekke strukturen, avhengighetene og konvensjonene. Veiled meg gjennom ett lite, etterprøvbart steg om gangen, med kommandoer for operativsystemet mitt, filplasseringer, forventede resultater og feilsøking. Vent på tilbakemeldingen min før du fortsetter. Følg denne rekkefølgen: konfigurer påloggingsinformasjon → gratis saldoforespørsel → implementer opplasting → lagre og hent en jobb gjentatte ganger → bekreft resultat og belastning. Ikke påstå at steg du ikke har utført, er fullført.

Base-URL: https://fahrface.org. Dokumentasjon: https://fahrface.org/developers; opprett nøkler: https://fahrface.org/settings/apikeys; fyll på: https://fahrface.org/pricing. Be meg opprette en nøkkel som utløper, med et lite budsjett. Obligatoriske omfang: face-age:write, face-age:read, credits:read; usage:read bare for brukshistorikk. Hemmeligheten vises én gang. Ikke be meg lime inn den ekte hemmeligheten i en AI-samtale. Bruk en serverbasert FAHRFACE_API_KEY-miljøvariabel, og utelat lokale filer med hemmeligheter fra versjonskontroll. Ikke legg hemmeligheter i kildekode, logger, nettleser- eller mobilkode, og ikke bruk prefiksene VITE_ eller NEXT_PUBLIC_. En webfrontend må kalle sin egen backend-proxy; dette API-et støtter ikke CORS-integrasjon fra nettleseren.

Alle endepunkter bruker https://fahrface.org, med Authorization: Bearer <FAHRFACE_API_KEY>. JSON-svar inneholder code, message, data; et vellykket svar krever code=0. POST bruker multipart/form-data med nøyaktig to felt: image (én JPEG-, PNG- eller WebP-fil, maksimalt 5 MiB, der det faktiske formatet samsvarer med MIME-typen) og consent=appearance-age-2026-10-21. Ingen eksterne bilde-URL-er, JSON-bildeinnhold, batcher eller ekstra felt. Når du bruker FormData, lar du HTTP-klienten angi Content-Type med boundary. Før opplasting må den faktiske brukeren uttrykkelig bekrefte at hen er minst 18 år, at dette er hens eget bilde, og at hen samtykker til behandling. Ikke forhåndsvelg eller finn på et samtykke. Endepunkter, 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: Opprettelse krever Idempotency-Key med 16–128 ASCII-bokstaver, sifre, understreker eller bindestreker (en UUID fungerer). Generer den én gang per tilsiktede nye test. Før du sender, lagrer du koblingen mellom nøkkelen og de nøyaktige opprinnelige filbytene, MIME-typen og samtykket. Samme konto, nøkkel og inndata gir den opprinnelige jobben uten en ny belastning; andre inndata med samme nøkkel gir HTTP 409. Ved tidsavbrudd på nettverket, nye forsøk og omstarter av prosessen må du bruke den opprinnelige nøkkelen og filen på nytt. Ikke generer en UUID inne i en løkke for nye forsøk. Hvis du sender en mislykket jobb på nytt med samme nøkkel, får du fortsatt den jobben; bare en uttrykkelig bestilt ny test skal få en ny nøkkel.

Asynkron flyt: En ny jobb gir HTTP 202, mens en forespørsel om samme jobb på nytt gir HTTP 200. Lagre data.id. Hent GET /api/v1/face-age/jobs/JOB_ID hvert 10.–15. sekund, og følg Retry-After og forespørselsgrensen for nøkkelen. queued, processing og retrying betyr at jobben ikke er ferdig; succeeded og failed er sluttstatuser. Ved suksess leser du tallverdien data.age (år) og data.billingStatus, og ved feil leser du data.error. Kaldstarter for HF kan ta flere minutter. Tidsfristen er 20 minutter; en aktiv arbeidsleie kan forsinke fullføringen med ytterligere 4 minutter, før planlagt gjenoppretting. At klienten slutter å vente, betyr ikke at serverjobben har feilet. Behold jobb-ID-en og la avspørringen fortsette senere; ikke opprett en ny betalingstest.

Betaling: Hver API-test reserverer 1 kreditt, beholder belastningen ved suksess og refunderer én gang ved endelig feil. Tester på nettstedet koster 10 kreditt fra samme saldo. GET-forespørsler er gratis, men teller med i forespørselsgrensene. Sjekk først GET /api/v1/credits data.available: verdien tar allerede hensyn til reservasjoner, så ikke trekk fra data.reserved en gang til. Forespørsler som avvises før opprettelse på grunn av utilstrekkelig saldo, ugyldige bilder eller grenseverdier, belastes ikke. Kontogrense: 60 autentiserte forespørsler i minuttet, inkludert spørringer; grensen kan være lavere for enkelte nøkler. Maksimalt to samtidige API-jobber per konto; en nøkkel kan tillate bare én. Nøkkelbudsjetter teller reserverte og gjennomførte belastninger; refusjoner frigjør budsjett. Tilbakekalte eller utløpte nøkler kan ikke brukes til spørringer. Bruksoversikten støtter page/pageSize, med maksimal pageSize på 100.

Feil: Sjekk HTTP-status og message, ikke bare om forespørselen ble fullført. 400 ugyldig forespørsel/samtykke/idempotensnøkkel; 401 ugyldig/utløpt/tilbakekalt nøkkel; 403 manglende scope; 402 utilstrekkelig kreditt; 404 manglende jobb eller feil konto; 409 motstridende inndata; 413 for stor fil; 415 feil format; 429 grense for forespørsler, samtidighet eller nøkkelbudsjett; 503 tjenesten er utilgjengelig. Rett opp konfigurasjonen eller inndataene ved 400/401/402/403/413/415 i stedet for å prøve på nytt uten å undersøke. Ved 409 gjenoppretter du de opprinnelige inndataene; bruk en ny nøkkel bare for en tilsiktet ny test. Ved 429 undersøker du message: grense for forespørsler/samtidighet betyr at du må vente i henhold til Retry-After; en budsjettgrense må justeres. Prøv på nytt ved nettverksfeil eller 503 med begrenset eksponentiell ventetid, og behold POST-forespørselens idempotensnøkkel. Behold den opprinnelige jobb-ID-en hvis det oppstår feil under avspørring.

Godkjenning: Kjør den kostnadsfrie saldoforespørselen først. Før en faktisk opplasting må du bekrefte med meg at jeg har et egnet portrettbilde av meg selv, at jeg samtykker, og forklare kredittreservasjonen. Kontroller at opprettelsen gir en jobb-ID, at en ny forespørsel med samme inndata og nøkkel gir samme ID, at avspørringen når en sluttstatus, at et vellykket resultat inneholder en alder og bare én belastning, og at avspørringen kan fortsette etter oppdatering eller omstart. Hvis saldoen eller tillatelsen til et faktisk kall mangler, må du være ærlig om at kontrollen bare er utført lokalt eller med en mock; ikke påstå at integrasjonen er testet mot live-tjenesten. Avslutt med kjøreinstruksjoner, navn på miljøvariabler, endrede filer og feilsøking. Ikke vis ekte hemmeligheter eller bildeinnhold.

Personvern og begrensninger: Bilder lagres midlertidig og privat, slettes etter behandling når jobben er avsluttet, og slettes senest etter 24 timer som en reserveordning. HF behandler portrettbildet. Appen min bør unngå å loggføre bilder eller nøkler og bør rydde opp i midlertidige filer. Resultatene anslår utseendealder på et bilde, og er ikke medisinske råd, identitetsbekreftelse eller bevis på alder. v1 har ingen webhook-tilbakemeldinger, eksterne bilde-URL-er eller batch-endepunkt; ikke finn på slike funksjoner. Begynn nå med å spørre om teknologistakken og distribusjonsoppsettet mitt, og veiled meg deretter gjennom det første steget.

Belastning

API: 1 kreditt per vellykket test. Nettsted: 10 kreditter per test. Begge bruker samme saldo. Når en API-jobb opprettes, reserveres 1 kreditt; ved endelig feil tilbakeføres den én gang.

Send Authorization: Bearer med det nødvendige omfanget. Bruk samme Idempotency-Key når du prøver på nytt med identiske bildefildata. Hvis du bruker nøkkelen på nytt med andre data, returneres HTTP 409. Forespørsler bruker ikke kreditter.

Endepunkter

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

Opprett en jobb

Bruk multipart/form-data med én bildefil (JPEG, PNG eller WebP, opptil 5 MB) og samtykkefeltet nedenfor. Bare voksne som sender inn sitt eget bilde med samtykke, kan bruke dette endepunktet. Eksterne URL-er og ekstra parametere avvises. Generer en ny idempotensnøkkel bare for en ny logisk test.

# Generer og lagre én nøkkel for hver nye test. Ved nye forsøk kjører du bare curl-kommandoen nedenfor med den opprinnelige nøkkelen og det opprinnelige bildet.
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 resultatet

Opprettelsen returnerer HTTP 202 og en jobb-ID. Send en ny forespørsel hvert 10.–15. sekund. queued, processing og retrying er ikke endelige statuser; succeeded og failed er endelige statuser. Oppvåkning av HF kan ta flere minutter. Jobber har en frist på 20 minutter; en aktiv worker-lease kan forsinke den endelige gjenopprettingen med opptil fire minutter til.

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

Feil og grenser

Svarene bruker code/message/data. HTTP 400: ugyldig forespørsel eller samtykke; 401: ugyldig/utløpt nøkkel; 403: manglende omfang; 402: utilstrekkelig saldo; 404: jobb mangler eller tilhører ikke kontoen; 409: endrede data; 413/415: ugyldig bildestørrelse/-type; 429: grense for forespørsler, samtidighet eller budsjett; 503: utilgjengelig. Følg Retry-After, bruk samme idempotensnøkkel på nytt, og les message før du prøver igjen.

Nøkler utløper innen ett år. Budsjettene inkluderer reserverte og brukte kreditter; refusjoner gjenoppretter budsjettet. Kontoen tillater 60 forespørsler per minutt og maksimalt to aktive API-jobber.

Portrettbilder lagres midlertidig i en privat lagringsbøtte og slettes etter endelig behandling, med en reserveordning som sletter dem etter 24 timer. HF behandler bildet; estimatene er ikke medisinske råd, identitetsbekreftelse eller aldersbevis.