Stapelnamen, E-Mails und Benutzernamen
POST /gender/batch akzeptiert ein items-Array mit 1–50 Einträgen mit API-Schlüsselzugriff oder höchstens 10 Einträgen mit der IP-Testversion. Senden Sie Namen, E-Mail-Adressen, Benutzernamen oder eine Mischung aus diesen dreien. Jeder Eintrag verfügt über separate Felder country, forceToGenderize und options. IDs sind optional, müssen jedoch innerhalb des Stapels eindeutig sein.
Die Ergebnisse folgen der Eingabereihenfolge. Jedes Ergebnis enthält index, charged_credits und genau eines von data oder error. Wenn Sie einen id geliefert haben, wird dieser ebenfalls zurückgegeben. Eine HTTP 200-Antwort kann Fehler für einzelne Einträge enthalten. Überprüfen Sie daher jedes Ergebnis. meta.summary umfasst total, succeeded, identified, unknown und failed. Eine abgeschlossene Vorhersage ohne bekanntes Geschlecht gilt dennoch als erfolgreich und kostet Credits.
Wenn die Anforderungsvalidierung oder -planung fehlschlägt, wird der gesamte Stapel abgelehnt, bevor Gutschriften abgezogen werden. Wenn alle Einträge während der Ausführung fehlschlagen, gibt die API eine Nicht-2xx-Problemantwort mit einem data-Array und dem Legacy-Alias results zurück. Für fehlgeschlagene Anmeldungen fallen nach einer bestätigten Rückerstattung keine Credits an. Wenn die Abrechnung nicht bestätigt ist, gehen Sie nicht davon aus, dass die gemeldeten Kosten für jeden Eintrag endgültig sind.
Wählen Sie eine Programmiersprache. Richten Sie Ihren API-Schlüssel ein, Führen Sie dann das Beispiel auf Ihrem Server aus.
Jede Vorhersageanfrage ist ein neuer kostenpflichtiger Vorgang, einschließlich Wiederholungsversuchen. Bei diesen Beispielen wird der Versuch nicht automatisch wiederholt. Überprüfen Sie den Rechnungsstatus, bevor Sie eine weitere Anfrage senden.
Vor der Ausführung: Zugriff und Fehlerbehandlung
Führen Sie diese Beispiele auf Ihrem Server aus. Setzen Sie GENDERAPI_API_KEY in der Prozessumgebung auf Ihren vorhandenen API-Schlüssel. Bestätigen Sie, dass meta.access.mode api_key ist: Ein nicht erkannter Schlüssel kann auf die IP-Testversion zurückgreifen.
Bei HTTP 4xx- und 5xx-JSON-Antworten behalten die Beispiele den Fehlertext bei und werden mit einem Status ungleich Null beendet. Überprüfen Sie code, action und meta.usage.billing_status, bevor Sie es erneut versuchen. Überprüfen Sie bei einer HTTP 200-Batch-Antwort auch data oder error in jedem Ergebnis.
Fehler- und Wiederholungsanleitung →cURL 7.76+ in einer POSIX-Shell. Führen Sie es in Ihrem Terminal aus. Laufzeitdokumentation
Node.js 22+; Integrierter Abruf. Speichern Sie es als example.mjs und führen Sie node example.mjs aus. Laufzeitdokumentation
Python 3.10+; Standardbibliothek. Speichern Sie es als example.py und führen Sie python3 example.py aus. Laufzeitdokumentation
PHP 8+ mit der cURL-Erweiterung. Speichern Sie es als example.php und führen Sie php example.php aus. Laufzeitdokumentation
Java 17+; Standard-HTTP-Client. Speichern Sie es als GenderApiExample.java und führen Sie java GenderApiExample.java aus. Laufzeitdokumentation
.NET 8+ Konsolenanwendung. Als Program.cs in einem Konsolenprojekt verwenden und dann dotnet run ausführen. Laufzeitdokumentation
Go 1.22+; Standardbibliothek. Speichern Sie es als main.go und führen Sie go run main.go aus. Laufzeitdokumentation
Lesen Sie eine Batch-Antwort
Dieses unabhängige synthetische Beispiel enthält eine Datensatzübereinstimmung, ein unbekanntes Ergebnis und einen Anbieterfehler. Es zeigt eine teilweise erfolgreiche HTTP 200-Antwort und nicht die erwartete Ausgabe der obigen Batch-Anfrage. Die beiden erfolgreichen Gegenstände kosten jeweils 1 Credit; Für den fehlerhaften Artikel wurde bestätigt, dass keine Gebühr erhoben wird.
{
"data": [
{
"index": 0,
"id": "known",
"charged_credits": 1,
"data": {
"input": {
"type": "name",
"value": "Onur",
"country": "TR"
},
"name": "onur",
"gender": "male",
"country": "TR",
"confidence": 0.9,
"confidence_kind": "observed_frequency",
"sample_count": 100,
"source": "dataset",
"result_status": "identified",
"reason": null,
"country_source": "dataset",
"match": {
"name": "onur",
"method": "normalized",
"scope": "country",
"country": "TR"
}
}
},
{
"index": 1,
"id": "missing",
"charged_credits": 1,
"data": {
"input": {
"type": "name",
"value": "zzzxxyy",
"country": null
},
"name": null,
"gender": null,
"country": null,
"confidence": null,
"confidence_kind": null,
"sample_count": null,
"source": "none",
"result_status": "unknown",
"reason": "not_found",
"country_source": null,
"match": {
"name": null,
"method": null,
"scope": null,
"country": null
}
}
},
{
"index": 2,
"id": "failed",
"charged_credits": 0,
"error": {
"type": "urn:genderapi:problem:ai_upstream_error",
"title": "ai upstream error",
"status": 502,
"detail": "The AI provider could not complete the request.",
"instance": "urn:uuid:11111111-1111-4111-8111-111111111111",
"code": "ai_upstream_error",
"request_id": "11111111-1111-4111-8111-111111111111",
"documentation": "https://api.genderapi.io/api/v2/errors",
"action": "inspect_billing_before_retry"
}
}
],
"meta": {
"request_id": "11111111-1111-4111-8111-111111111111",
"duration_ms": 12,
"access": {
"mode": "ip_trial",
"reason": "api_key_missing"
},
"usage": {
"charged_credits": 2,
"remaining_credits": 6,
"billing_status": "confirmed",
"resets_at": "2026-09-26T12:00:00.000Z",
"limit": 10,
"period_seconds": 86400
},
"summary": {
"total": 3,
"succeeded": 2,
"identified": 1,
"unknown": 1,
"failed": 1
}
}
}Planen Sie Stapelgutschriften und Wiederholungsversuche
Authentifizieren Sie sich mit Ihrem vorhandenen Schlüssel Bearer API und senden Sie Content-Type: application/json. Jeder übermittelte Stapel ist ein neuer Vorgang. Wenn Sie einen Teilfehler erneut versuchen, reichen Sie nach Prüfung der Abrechnung nur die fehlgeschlagenen Artikel ein. Durch das erneute Versenden erfolgreicher Artikel werden diese erneut belastet.
Batch-Einträge verwenden standardmäßig off und kosten pro abgeschlossener Vorhersage 1 Credit. fallback kostet ebenfalls insgesamt 1 Credit, einschließlich KI. always kostet 2 Credits. Bei forceToGenderize kostet ein identifiziertes Datensatzergebnis 1 Credit; wird KI verwendet, sind es insgesamt 2 Credits. Auch abgeschlossene Vorhersagen mit unbekanntem Geschlecht sind kostenpflichtig. Ein positiver Startsaldo von 1 Credit genügt für einen Batch; die endgültige Abbuchung kann zu einem negativen Kontostand führen.