Přehled požadavku
Odesílejte jedno jméno v každém požadavku
Odešlete objekt JSON s křestním jménem a autentizujte se Bearer tokenem. Kód země přidejte tehdy, když mohou regionální zvyklosti pojmenování zpřesnit odhad.
Povinné HTTP hlavičky
Autorizujte požadavek
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTělo požadavku JSON
Parametry
| Parametr | Typ | Požadavek | Popis |
|---|---|---|---|
name | string | Povinné | Křestní jméno k analýze. Použijte čistou hodnotu bez titulů a předpon. |
country | string | Volitelné | Kód země ISO 3166-1 alpha-2, například CZ nebo US, který doplní regionální kontext. |
askToAI | boolean | Volitelné | Při hodnotě true použije podporu AI, pokud jméno není nalezeno v databázi. |
forceToGenderize | boolean | Volitelné | Při hodnotě true se pokusí získat výsledek pro přezdívky nebo vstupy, které nepřipomínají běžná jména. |
Parametr askToAI se použije pouze tehdy, když databáze nemá výsledek. Vynucené odhady neobvyklých vstupů mohou být méně spolehlivé, proto pravděpodobnost považujte za důležitý signál.
Příklady kódu
Odešlete jednotlivý požadavek
Následující příklady odesílají stejný požadavek s Bearer autentizací.
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Tereza","country":"CZ","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: "Tereza", country: "CZ", 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": "Tereza", "country": "CZ", "askToAI": True}
)
print(response.json())Odpověď 200
Výsledek odhadu
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Tereza",
"name": "Tereza",
"gender": "female",
"country": "CZ",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}Pole odpovědi
| Pole | Typ | Popis |
|---|---|---|
status | boolean | Určuje, zda byl požadavek úspěšně zpracován. |
used_credits | integer | Počet kreditů spotřebovaných požadavkem. |
remaining_credits | integer | Počet kreditů dostupných po zpracování požadavku. |
expires | integer | Čas vypršení balíčku jako časové razítko UNIX. |
q | string | Původní jméno odeslané v požadavku. |
name | string | Jméno analyzované službou GenderAPI. |
gender | string | null | Odhadovaná hodnota: male, female nebo null. |
country | string | Kód země zohledněný při odhadu. |
total_names | integer | Počet vzorků podporujících odhad. |
probability | integer | Míra spolehlivosti odhadu v procentech. |
duration | string | Doba zpracování na serveru. |
Odesílejte čistý a správně kódovaný vstup
Použijte křestní jméno bez titulů a předpon. Klienti JSON řeší kódování automaticky, externí vstup však vždy ověřte ještě před vytvořením těla požadavku.
Další průvodce