Køn ud fra navn API – Dokumentation til enkelt forespørgsel

Oversigt over forespørgslen

Send ét navn pr. forespørgsel

Indsend et JSON-objekt med et fornavn, og godkend med et Bearer-token. Tilføj en landekode, når regionale navnemønstre kan forbedre estimeringen.

MetodePOST

Indholdstypeapplication/json

GodkendelseBearer-token

Kreditforbrug1 opslag

HDR

Påkrævede HTTP-headere

Godkend forespørgslen

Content-Typeapplication/json

AuthorizationBearer YOUR_API_KEY

Opbevar API-nøglen i miljøvariabler på serversiden. Se vejledningen til godkendelse for sikker håndtering af adgangsoplysninger.

JSON-request body

Parametre

Parameter	Type	Krav	Beskrivelse
`name`	string	Påkrævet	Fornavnet, der skal analyseres. Brug en ren navneværdi uden titler eller præfikser.
`country`	string	Valgfri	ISO 3166-1 alpha-2-landekode, f.eks. DK eller US, som tilføjer regional kontekst.
`askToAI`	boolean	Valgfri	Når værdien er true, bruges AI som fallback, hvis navnet ikke findes i databasen.
`forceToGenderize`	boolean	Valgfri	Når værdien er true, forsøges et resultat for kaldenavne eller input, som ikke ligner typiske personnavne.

Om AI-fallback

askToAI bruges kun, når databasen ikke giver et resultat. Tvungne estimeringer for usædvanligt input kan være mindre pålidelige, så betragt sandsynligheden som et vigtigt signal.

Kodeeksempler

Send en enkelt forespørgsel

Eksemplerne sender den samme forespørgsel med Bearer-godkendelse.

cURL

curl -X POST "https://api.genderapi.io/api" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"name":"Alice","country":"DK","askToAI":true}'

JavaScript

const response = await fetch("https://api.genderapi.io/api", {
  method: "POST",
  headers: {"Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY"},
  body: JSON.stringify({ name: "Alice", country: "DK", askToAI: true })
});
const data = await response.json();

Python

import requests
response = requests.post(
  "https://api.genderapi.io/api",
  headers={"Authorization": "Bearer YOUR_API_KEY"},
  json={"name": "Alice", "country": "DK", "askToAI": True}
)
print(response.json())

200-svar

Estimeringsresultat

JSON

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "Alice",
  "name": "Alice",
  "gender": "female",
  "country": "DK",
  "total_names": 10234,
  "probability": 98,
  "duration": "4ms"
}

Svarfelter

Felt	Type	Beskrivelse
`status`	boolean	Angiver, om forespørgslen blev gennemført korrekt.
`used_credits`	integer	Antal kreditter, som forespørgslen brugte.
`remaining_credits`	integer	Tilgængelige kreditter efter forespørgslen.
`expires`	integer	Pakkens udløbstid som UNIX-tidsstempel.
`q`	string	Det oprindelige navn i forespørgslen.
`name`	string	Navnet, som GenderAPI analyserede.
`gender`	string \| null	Estimeret værdi: male, female eller null.
`country`	string	Landekoden, der indgik i estimeringen.
`total_names`	integer	Antal navneposter, som understøtter estimeringen.
`probability`	integer	Estimeringens sandsynlighed i procent.
`duration`	string	Serverens behandlingstid.

Send rent og korrekt kodet input

Brug et fornavn uden titler eller præfikser. JSON-klienter håndterer kodning automatisk, men validér altid eksternt input, før request bodyen oprettes.

Næste vejledning

Analysér flere navne

Forespørgsel med flere navneBehandl flere navne i én forespørgsel →GodkendelseGennemgå sikkerhed for API-nøgler →