Přehled hromadného požadavku
Zpracujte až 50 uživatelských jmen
Odešlete pole data. GenderAPI z každého profilového názvu extrahuje pravděpodobný signál jména a výsledky vrátí s vaším volitelným identifikátorem id.
Profilové názvy mohou obsahovat značky, fantazijní výrazy nebo nesouvisející slova. Hromadné požadavky nepřijímají askToAI ani forceToGenderize. Pro přesnější zpracování neobvyklých vstupů použijte jednotlivý požadavek.
Povinné HTTP hlavičky
Autorizujte hromadný požadavek
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTělo požadavku JSON
Parametry
| Pole | Typ | Požadavek | Popis |
|---|---|---|---|
data | object[] | Povinné | Pole obsahující 1 až 50 záznamů uživatelských jmen. |
data[].username | string | Povinné | Uživatelské jméno nebo profilový název k analýze; podporovány jsou podtržítka i číslice. |
data[].country | string | Volitelné | Kód země ISO 3166-1 alpha-2 použitý jako regionální kontext. |
data[].id | string | integer | Volitelné | Váš identifikátor vrácený beze změny s odpovídajícím výsledkem. |
Uživatelská jména psaná latinkou obvykle poskytují zřetelnější signály. Používejte jedinečná ida před aktualizací záznamů zkontrolujte extrahované name i hodnotu probability.
Datová část požadavku
Sestavte pole uživatelských jmen
{
"data": [
{ "username": "tereza_novakova88", "country": "CZ", "id": "123" },
{ "username": "jakub_svoboda", "country": "CZ", "id": "456" },
{ "username": "anna_smith", "country": "US", "id": "789" }
]
}Ukázky kódu
Odešlete požadavek s více uživatelskými jmény
curl -X POST "https://api.genderapi.io/api/username/multi/country" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"data":[{"username":"tereza_novakova88","country":"CZ","id":"123"},{"username":"jakub_svoboda","country":"CZ","id":"456"}]}'const data = [
{ username: "tereza_novakova88", country: "CZ", id: "123" },
{ username: "jakub_svoboda", country: "CZ", id: "456" }
];
const response = await fetch("https://api.genderapi.io/api/username/multi/country", {
method: "POST", headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ data })
});Odpověď 200
Extrahovaná jména a odhady
{
"status": true, "used_credits": 3, "remaining_credits": 7265, "expires": 1717069765,
"names": [
{ "name": "Tereza", "q": "tereza_novakova88", "gender": "female", "country": "CZ", "total_names": 1234, "probability": 96, "id": "123" },
{ "name": "Jakub", "q": "jakub_svoboda", "gender": "male", "country": "CZ", "total_names": 5678, "probability": 98, "id": "456" }
], "duration": "5ms"
}Pole odpovědi
| Pole | Typ | Popis |
|---|---|---|
status | boolean | Určuje, zda byl hromadný požadavek úspěšně zpracován. |
used_credits | integer | Počet kreditů spotřebovaných pro odeslaná uživatelská jména. |
remaining_credits | integer | Počet kreditů dostupných po požadavku. |
expires | integer | Čas vypršení balíčku jako časové razítko UNIX. |
names | object[] | Výsledky pro odeslaná uživatelská jména. |
names[].name | string | Pravděpodobné jméno extrahované z uživatelského jména. |
names[].q | string | Původní uživatelské jméno odeslané v požadavku. |
names[].gender | string | null | Odhadovaná hodnota: male, female nebo null. |
names[].country | string | Kód země zohledněný u daného výsledku. |
names[].total_names | integer | Počet vzorků podporujících daný výsledek. |
names[].probability | integer | Míra spolehlivosti odhadu v procentech. |
names[].id | string | integer | Vstupní identifikátor vrácený pro spárování záznamu. |
duration | string | Celková doba zpracování na serveru. |
V jednom požadavku odesílejte nejvýše 50 záznamů
Větší vstupy rozdělte do dávek. Uživatelské jméno je nepřímý signál, proto před použitím výsledků ověřte extrahované jméno a stanovte přijatelnou hranici pravděpodobnosti.
Další referenční příručka