เอกสาร API V2

การคาดคะเนชื่อแบทช์ อีเมล และชื่อผู้ใช้

ส่งการคาดการณ์ GenderAPI v2 มากถึง 50 รายการในชุดเดียว เรียนรู้ตัวเลือกต่อรายการ รหัสที่สงวนไว้ ความล้มเหลวบางส่วน สรุปคำตอบ และการบัญชีเครดิต

ชื่อแบทช์ อีเมล และชื่อผู้ใช้

POST /gender/batch ยอมรับอาร์เรย์ items ที่มี 1–50 รายการพร้อมการเข้าถึงคีย์ API หรือสูงสุด 10 รายการพร้อมการทดลองใช้ IP ส่งชื่อ ที่อยู่อีเมล ชื่อผู้ใช้ หรือทั้งสามอย่างผสมกัน แต่ละรายการมีฟิลด์ country, forceToGenderize และ options แยกต่างหาก รหัสเป็นทางเลือก แต่ต้องไม่ซ้ำกันภายในกลุ่ม

ผลลัพธ์เป็นไปตามลำดับอินพุต ผลลัพธ์แต่ละรายการประกอบด้วย index, charged_credits และหนึ่งใน data หรือ error หากคุณระบุ id ก็จะถูกส่งคืนเช่นกัน การตอบสนอง HTTP 200 อาจมีความล้มเหลวสำหรับแต่ละรายการ ดังนั้นให้ตรวจสอบทุกผลลัพธ์ meta.summary ประกอบด้วย total, succeeded, identified, unknown และ failed การทำนายที่สมบูรณ์โดยไม่ทราบเพศยังคงถือว่าสำเร็จและต้องเสียเครดิต

หากการตรวจสอบคำขอหรือการวางแผนล้มเหลว ทั้งชุดจะถูกปฏิเสธก่อนที่จะหักเครดิตใดๆ หากรายการทั้งหมดล้มเหลวระหว่างการดำเนินการ API จะส่งคืนการตอบกลับปัญหาที่ไม่ใช่ 2xx ด้วยอาร์เรย์ data และนามแฝงเดิม results การเข้าร่วมที่ล้มเหลวจะเสียเครดิตเป็นศูนย์หลังจากยืนยันการคืนเงินแล้ว หากการเรียกเก็บเงินไม่ได้รับการยืนยัน อย่าถือว่าค่าใช้จ่ายที่รายงานสำหรับแต่ละรายการถือเป็นที่สิ้นสุด

เลือกภาษาโปรแกรม ตั้งค่าคีย์ API ของคุณ, จากนั้นเรียกใช้ตัวอย่างบนเซิร์ฟเวอร์ของคุณ

ทุกคำขอการคาดการณ์เป็นการดำเนินการที่เรียกเก็บเงินได้ใหม่ รวมถึงการลองใหม่ด้วย ตัวอย่างเหล่านี้ไม่ได้ลองอีกครั้งโดยอัตโนมัติ ตรวจสอบสถานะการเรียกเก็บเงินก่อนที่จะส่งคำขออื่น

ก่อนที่คุณจะเรียกใช้: การเข้าถึงและการจัดการข้อผิดพลาด

เรียกใช้ตัวอย่างเหล่านี้บนเซิร์ฟเวอร์ของคุณ ตั้งค่า GENDERAPI_API_KEY ในสภาพแวดล้อมกระบวนการเป็นคีย์ API ที่มีอยู่ของคุณ ยืนยันว่า meta.access.mode คือ api_key: คีย์ที่ไม่รู้จักสามารถถอยกลับไปยังรุ่นทดลอง IP ได้

สำหรับการตอบสนอง HTTP 4xx และ 5xx JSON ตัวอย่างจะคงเนื้อหาข้อผิดพลาดและออกด้วยสถานะที่ไม่ใช่ศูนย์ ตรวจสอบ code, action และ meta.usage.billing_status ก่อนลองอีกครั้ง สำหรับการตอบสนองแบบแบตช์ HTTP 200 ให้ตรวจสอบ data หรือ error ในแต่ละผลลัพธ์ด้วย

ข้อผิดพลาดและคำแนะนำในการลองอีกครั้ง →
cURL
curl --silent --show-error --fail-with-body --max-time 30 \
  --request POST 'https://api.genderapi.io/api/v2/gender/batch' \
  --header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
  "items": [
    {
      "id": "contact-1",
      "type": "name",
      "value": "Onur",
      "country": "TR"
    },
    {
      "id": "contact-2",
      "type": "email",
      "value": "alice.smith@example.com",
      "options": {
        "ai_mode": "fallback"
      }
    },
    {
      "id": "contact-3",
      "type": "username",
      "value": "prenses",
      "country": "TR",
      "forceToGenderize": true
    }
  ]
}'

cURL 7.76+ ในเชลล์ POSIX. วิ่งในเทอร์มินัลของคุณ เอกสารรันไทม์

JavaScript / Node.js
// Server-side Node.js. Save as example.mjs.
const apiKey = process.env.GENDERAPI_API_KEY;
if (!apiKey) throw new Error("Set GENDERAPI_API_KEY");
const body = {
  "items": [
    {
      "id": "contact-1",
      "type": "name",
      "value": "Onur",
      "country": "TR"
    },
    {
      "id": "contact-2",
      "type": "email",
      "value": "alice.smith@example.com",
      "options": {
        "ai_mode": "fallback"
      }
    },
    {
      "id": "contact-3",
      "type": "username",
      "value": "prenses",
      "country": "TR",
      "forceToGenderize": true
    }
  ]
};

const response = await fetch("https://api.genderapi.io/api/v2/gender/batch", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000),
  redirect: "error",
});
const raw = await response.text();
if (!(response.headers.get("content-type") ?? "").includes("json")) {
  throw new Error(`HTTP ${response.status}: expected JSON; request ID ${response.headers.get("x-request-id")}`);
}
const result = JSON.parse(raw); // Also accepts application/problem+json.
if (!response.ok) {
  console.error(`HTTP ${response.status}`, result);
  process.exitCode = 1; // A retry is a new operation; inspect billing first.
} else {
  console.log(JSON.stringify(result, null, 2));
  // For batches, inspect every item: HTTP 200 may contain item errors.
}

Node.js 22+; ดึงข้อมูลในตัว. บันทึกเป็น example.mjs และรัน node example.mjs เอกสารรันไทม์

Python
import json
import os
import sys
import urllib.error
import urllib.request

api_key = os.environ.get("GENDERAPI_API_KEY")
if not api_key:
    raise RuntimeError("Set GENDERAPI_API_KEY")
body = json.loads("{\"items\":[{\"id\":\"contact-1\",\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"},{\"id\":\"contact-2\",\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"options\":{\"ai_mode\":\"fallback\"}},{\"id\":\"contact-3\",\"type\":\"username\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}]}")

class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

request = urllib.request.Request(
    "https://api.genderapi.io/api/v2/gender/batch",
    method="POST",
    data=json.dumps(body).encode("utf-8"),
    headers={
        "Authorization": "Bearer " + api_key,
        "Content-Type": "application/json",
    },
)
opener = urllib.request.build_opener(NoRedirect())
try:
    response = opener.open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error  # Keep the Problem Details body on non-2xx responses.
with response:
    status = response.status
    raw = response.read().decode("utf-8")
    if "json" not in response.headers.get("Content-Type", ""):
        raise RuntimeError(f"HTTP {status}: expected a JSON response")
    result = json.loads(raw)
print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)
if not 200 <= status < 300:
    sys.exit(1)  # Inspect code, action and billing before retrying.
# For batches, inspect every item even when HTTP status is 200.

Python 3.10+; ห้องสมุดมาตรฐาน. บันทึกเป็น example.py และรัน python3 example.py เอกสารรันไทม์

PHP
<?php
$apiKey = getenv('GENDERAPI_API_KEY');
if (!$apiKey) {
    throw new RuntimeException('Set GENDERAPI_API_KEY');
}
$body = json_decode('{"items":[{"id":"contact-1","type":"name","value":"Onur","country":"TR"},{"id":"contact-2","type":"email","value":"alice.smith@example.com","options":{"ai_mode":"fallback"}},{"id":"contact-3","type":"username","value":"prenses","country":"TR","forceToGenderize":true}]}', true, 512, JSON_THROW_ON_ERROR);

$ch = curl_init('https://api.genderapi.io/api/v2/gender/batch');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$raw = curl_exec($ch);
if ($raw === false) {
    throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE) ?: '';
curl_close($ch);
if (strpos($contentType, 'json') === false) {
    throw new RuntimeException("HTTP $status: expected a JSON response");
}
$result = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
$output = json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR) . PHP_EOL;
if ($status < 200 || $status >= 300) {
    fwrite(STDERR, $output); // Preserve the Problem Details body.
    exit(1);
}
echo $output;
// For batches, inspect every item; HTTP 200 can contain item errors.

PHP 8+ พร้อมส่วนขยาย cURL. บันทึกเป็น example.php และรัน php example.php เอกสารรันไทม์

Java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class GenderApiExample {
    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name);
        return value;
    }

    public static void main(String[] args) throws Exception {
        String apiKey = requiredEnv("GENDERAPI_API_KEY");
        String body = "{\"items\":[{\"id\":\"contact-1\",\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"},{\"id\":\"contact-2\",\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"options\":{\"ai_mode\":\"fallback\"}},{\"id\":\"contact-3\",\"type\":\"username\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}]}";
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .followRedirects(HttpClient.Redirect.NEVER)
            .build();
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/gender/batch"))
            .timeout(Duration.ofSeconds(30))
            .header("Authorization", "Bearer " + apiKey)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .build();
        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
        if (!response.headers().firstValue("content-type").orElse("").contains("json")) {
            throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON");
        }
        // JSON text; parse with your application's JSON library when integrating.
        if (response.statusCode() < 200 || response.statusCode() >= 300) {
            System.err.println(response.body()); // Includes Problem Details.
            System.exit(1);
        }
        System.out.println(response.body());
        // For batches, inspect each item's data or error, including on HTTP 200.
    }
}

Java 17+; ไคลเอนต์ HTTP มาตรฐาน. บันทึกเป็น GenderApiExample.java และรัน java GenderApiExample.java เอกสารรันไทม์

C# / .NET
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;

string RequiredEnv(string name) =>
    !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name))
        ? Environment.GetEnvironmentVariable(name)!
        : throw new InvalidOperationException($"Set {name}");

var apiKey = RequiredEnv("GENDERAPI_API_KEY");
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.genderapi.io/api/v2/gender/batch");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
request.Content = new StringContent("{\"items\":[{\"id\":\"contact-1\",\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"},{\"id\":\"contact-2\",\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"options\":{\"ai_mode\":\"fallback\"}},{\"id\":\"contact-3\",\"type\":\"username\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}]}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
var raw = await response.Content.ReadAsStringAsync();
if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false))
    throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");
using var result = JsonDocument.Parse(raw);
if (!response.IsSuccessStatusCode)
{
    Console.Error.WriteLine(result.RootElement); // Preserve Problem Details.
    Environment.ExitCode = 1;
}
else
{
    Console.WriteLine(result.RootElement);
    // For batches, inspect every item even on HTTP 200.
}

แอปพลิเคชันคอนโซล .NET 8+. ใช้เป็น Program.cs ในโปรเจ็กต์คอนโซล จากนั้นเรียกใช้ dotnet run เอกสารรันไทม์

Go
package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
    "strings"
    "time"
)

func requiredEnv(name string) string {
    value := os.Getenv(name)
    if value == "" { panic("Set " + name) }
    return value
}

func run() error {
    apiKey := requiredEnv("GENDERAPI_API_KEY")
    body := "{\"items\":[{\"id\":\"contact-1\",\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"},{\"id\":\"contact-2\",\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"options\":{\"ai_mode\":\"fallback\"}},{\"id\":\"contact-3\",\"type\":\"username\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}]}"
    request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/gender/batch", strings.NewReader(body))
    if err != nil { return err }
    request.Header.Set("Authorization", "Bearer " + apiKey)
    request.Header.Set("Content-Type", "application/json")
    client := &http.Client{
        Timeout: 30 * time.Second,
        CheckRedirect: func(req *http.Request, via []*http.Request) error {
            return http.ErrUseLastResponse
        },
    }
    response, err := client.Do(request)
    if err != nil { return err }
    defer response.Body.Close()
    raw, err := io.ReadAll(response.Body)
    if err != nil { return err }
    if !strings.Contains(response.Header.Get("Content-Type"), "json") || !json.Valid(raw) {
        return fmt.Errorf("HTTP %d: expected a JSON response", response.StatusCode)
    }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        return fmt.Errorf("HTTP %d: %s", response.StatusCode, raw)
    }
    fmt.Println(string(raw))
    // For batches, inspect every item even on HTTP 200.
    return nil
}

func main() {
    if err := run(); err != nil {
        fmt.Fprintln(os.Stderr, err) // Keep Problem Details for error handling.
        os.Exit(1)
    }
}

Go 1.22+; ห้องสมุดมาตรฐาน. บันทึกเป็น main.go และรัน go run main.go เอกสารรันไทม์

อ่านการตอบกลับเป็นชุด

ตัวอย่างสังเคราะห์อิสระนี้มีการจับคู่ชุดข้อมูล ผลลัพธ์ที่ไม่ทราบ และความล้มเหลวของผู้ให้บริการ ซึ่งแสดงการตอบสนอง HTTP 200 ที่ประสบความสำเร็จบางส่วน ไม่ใช่เอาต์พุตที่คาดหวังของคำขอแบตช์ด้านบน รายการที่สำเร็จทั้งสองรายการมีราคา 1 เครดิตต่อรายการ สินค้าที่ล้มเหลวได้รับการยืนยันว่ามีการเรียกเก็บเงินเป็นศูนย์

ตัวอย่างการตอบสนอง JSON
{
  "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
    }
  }
}

วางแผนเครดิตแบทช์และลองอีกครั้ง

ตรวจสอบสิทธิ์ด้วยคีย์ Bearer API ที่มีอยู่ของคุณ และส่ง Content-Type: application/json ทุกแบทช์ที่ส่งมาคือการดำเนินการใหม่ หากลองดำเนินการล้มเหลวบางส่วนอีกครั้ง ให้ส่งเฉพาะรายการที่ล้มเหลวหลังจากตรวจสอบการเรียกเก็บเงินแล้ว การส่งสินค้าที่สำเร็จอีกครั้งจะเรียกเก็บเงินอีกครั้ง

ตามค่าเริ่มต้น รายการแบทช์จะใช้ off และมีค่าใช้จ่าย 1 เครดิตต่อการทำนายที่เสร็จสมบูรณ์ การเลือก fallback ยังต้องใช้ 1 เครดิตรวม AI ด้วย การเลือก always ต้องใช้ 2 เครดิต ด้วย forceToGenderize เพศที่พบในชุดข้อมูลมีค่าใช้จ่าย 1 เครดิต การใช้ AI มีค่าใช้จ่ายทั้งหมด 2 เครดิต การทำนายที่ไม่ทราบเพศเสร็จสมบูรณ์ยังต้องเสียเครดิตด้วย ยอดคงเหลือเริ่มต้น 1 เครดิตก็เพียงพอแล้วสำหรับการเริ่มต้นชุดงาน การหักเงินครั้งสุดท้ายอาจทำให้ยอดคงเหลือติดลบ