Przegląd zapytania
Wyślij jedno imię w zapytaniu
Prześlij obiekt JSON zawierający imię i uwierzytelnij zapytanie tokenem Bearer. Dodaj kod kraju, gdy regionalne wzorce imion mogą poprawić trafność prognozy.
Wymagane nagłówki HTTP
Autoryzuj zapytanie
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTreść JSON zapytania
Parametry
| Parametr | Typ | Status | Opis |
|---|---|---|---|
name | string | Wymagany | Imię do analizy. Przekaż czystą wartość bez tytułów i prefiksów. |
country | string | Opcjonalny | Dwuliterowy kod kraju ISO 3166-1 alpha-2, na przykład PL lub US, dodający kontekst regionalny. |
askToAI | boolean | Opcjonalny | Wartość true uruchamia wsparcie AI, jeśli imienia nie znaleziono w bazie danych. |
forceToGenderize | boolean | Opcjonalny | Wartość true próbuje zwrócić wynik dla pseudonimu lub wartości, która nie przypomina typowego imienia. |
askToAI jest używane tylko wtedy, gdy baza danych nie zwróci wyniku. Wymuszone prognozy dla nietypowych wartości mogą być mniej wiarygodne, dlatego traktuj probability jako ważny sygnał kontrolny.
Przykłady kodu
Wykonaj pojedyncze zapytanie
Każdy przykład wysyła to samo zapytanie z uwierzytelnianiem Bearer.
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Anna","country":"PL","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: "Anna", country: "PL", 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": "Anna", "country": "PL", "askToAI": True}
)
print(response.json())Odpowiedź 200
Wynik prognozy
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Anna",
"name": "Anna",
"gender": "female",
"country": "PL",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status | boolean | Informuje, czy zapytanie zostało prawidłowo obsłużone. |
used_credits | integer | Liczba kredytów wykorzystanych przez zapytanie. |
remaining_credits | integer | Liczba kredytów dostępnych po zapytaniu. |
expires | integer | Czas wygaśnięcia pakietu jako znacznik UNIX. |
q | string | Oryginalne imię przesłane w zapytaniu. |
name | string | Imię przeanalizowane przez GenderAPI. |
gender | string | null | Przewidywana wartość: male, female albo null. |
country | string | Kod kraju uwzględniony w prognozie. |
total_names | integer | Liczba próbek wspierających prognozę. |
probability | integer | Poziom pewności prognozy w procentach. |
duration | string | Czas przetwarzania po stronie serwera. |
Wysyłaj czyste i prawidłowo zakodowane dane
Używaj imienia bez tytułów ani prefiksów. Klienty JSON automatycznie obsługują kodowanie, ale zawsze waliduj dane zewnętrzne przed utworzeniem treści zapytania.
Następny przewodnik