Oversikt over forespørselen
Send ett navn per forespørsel
Send et JSON-objekt med et fornavn, og autentiser med et Bearer-token. Legg til en landkode når regionale navnemønstre kan forbedre prediksjonen.
Påkrevde HTTP-headere
Autoriser forespørselen
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYJSON-body for forespørselen
Parametere
| Parameter | Type | Krav | Beskrivelse |
|---|---|---|---|
name | string | Påkrevd | Fornavnet som skal analyseres. Bruk et rent navnefelt uten titler eller prefikser. |
country | string | Valgfri | ISO 3166-1 alfa-2-landkode, for eksempel NO eller SE, som gir regional kontekst. |
askToAI | boolean | Valgfri | Når verdien er true, brukes KI som reserve hvis navnet ikke finnes i databasen. |
forceToGenderize | boolean | Valgfri | Når verdien er true, forsøkes et resultat for kallenavn eller inndata som ikke ligner vanlige navn. |
askToAI brukes bare når databasen ikke gir et resultat. Tvungne prediksjoner for uvanlige inndata kan være mindre pålitelige, så bruk sannsynligheten som et viktig kvalitetssignal.
Kodeeksempler
Send en enkeltforespørsel
Eksemplene sender den samme forespørselen med Bearer-autentisering.
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Alice","country":"US","askToAI":true}'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: "US", askToAI: true })
});
const data = await response.json();import requests
response = requests.post(
"https://api.genderapi.io/api",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Alice", "country": "US", "askToAI": True}
)
print(response.json())200-svar
Prediksjonsresultat
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "Alice",
"gender": "female",
"country": "US",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}Svarfelt
| Felt | Type | Beskrivelse |
|---|---|---|
status | boolean | Om forespørselen ble fullført uten feil. |
used_credits | integer | Antall kreditter som forespørselen brukte. |
remaining_credits | integer | Antall kreditter som er tilgjengelige etter forespørselen. |
expires | integer | Pakkens utløpstid som UNIX-tidsstempel. |
q | string | Det opprinnelige navnet som ble sendt i forespørselen. |
name | string | Navnet som GenderAPI analyserte. |
gender | string | null | Predikert verdi: male, female eller null. |
country | string | Landkoden som ble brukt i prediksjonen. |
total_names | integer | Antall navneforekomster som støtter prediksjonen. |
probability | integer | Prediksjonens konfidens uttrykt i prosent. |
duration | string | Serverens behandlingstid. |
Send rene og riktig kodede inndata
Bruk et fornavn uten titler eller prefikser. JSON-klienter håndterer koding automatisk, men valider alltid eksterne inndata før du oppretter forespørselsbodyen.
Neste veiledning