# พารามิเตอร์คำขอ API v2

> อธิบายฟิลด์ type, value, country, forceToGenderize และ ai_mode ของ GenderAPI V2 พร้อมความแตกต่างระหว่างพารามิเตอร์ GET กับเนื้อหา JSON ของคำขอ POST

Canonical HTML: https://www.genderapi.io/th/docs/v2/request-parameters

Last reviewed: 2026-09-25

## พารามิเตอร์การทำนายเดี่ยว

ควรละเว้นฟิลด์ตัวเลือกเมื่อไม่ได้ใช้ อย่าส่ง null หรือสตริงว่างแทนที่ country หรือ options บูลีน JSON ต้องเป็น true หรือ false ไม่ใช่สตริง รองรับข้อความ UTF-8; ไม่จำเป็นต้องทับศัพท์เป็น ASCII

GET ใช้ type, value, country, forceToGenderize และ ai_mode โดยตรงในสตริงการสืบค้น รวมถึง key เผื่อเลือก เข้ารหัสค่าด้วยตัวเข้ารหัสพารามิเตอร์ URL ของไคลเอ็นต์ HTTP ของคุณ เช่น @ กลายเป็น %40 สำหรับ GET บูลีน ให้ส่ง true หรือ false ช่องที่ไม่รู้จักและค่าที่ไม่ถูกต้องจะถูกปฏิเสธ

| ฟิลด์ JSON | ประเภท | กฎ |
| --- | --- | --- |
| type | string | จำเป็นสำหรับ POST: name, email หรือ username GET มีค่าเริ่มต้นเป็น name |
| value | string | จำเป็น 1–254 อักขระ; ไม่ว่าง โดยไม่มีอักขระควบคุม ค่าอีเมลจะต้องเป็นไวยากรณ์อีเมลที่ถูกต้อง |
| country | string | รหัส ISO 3166-1 alpha-2 ตัวพิมพ์ใหญ่ที่เป็นตัวเลือก เช่น TR หรือ US การค้นหาเฉพาะประเทศสามารถย้อนกลับไปที่ชุดข้อมูลส่วนกลางได้ |
| forceToGenderize | boolean | ไม่บังคับ ค่าเริ่มต้นคือ false ค้นหาในชุดข้อมูลก่อน หากยังระบุเพศไม่ได้จึงใช้ AI ตีความชื่อเล่น รองรับข้อมูลทั้งสามประเภท |
| options.ai_mode | string | off, fallback หรือ always ค่าเริ่มต้นเป็น fallback สำหรับคำขอเดี่ยว และ off สำหรับรายการแบตช์ |
| id | string | ตัวระบุที่ไม่บังคับ ความยาว 1–64 อักขระใน JSON ของ POST ต้องไม่ซ้ำภายในชุดเดียวกัน และจะส่งกลับพร้อมผลลัพธ์แต่ละรายการ คำขอเดี่ยวรับค่านี้ได้แต่ไม่ส่งกลับในคำตอบ ไม่รองรับในพารามิเตอร์ GET |

## ก่อนส่งคำขอ

ส่ง JSON ไปที่ POST https://api.genderapi.io/api/v2/gender ใช้คีย์ API ที่มีอยู่ใน Authorization: Bearer YOUR_API_KEY และ Content-Type: application/json ทุกคำขอได้รับการประมวลผลโดยอิสระ

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

- [การรับรองความถูกต้องและการเข้าถึงแบบทดลองใช้](https://www.genderapi.io/th/docs/v2/authentication)
- [พารามิเตอร์คำขอทั้งหมด](https://www.genderapi.io/th/docs/v2/request-parameters)

## ขอตัวอย่างตามภาษา

ตัวอย่างนี้ใช้ฟิลด์คำขอที่ใช้ร่วมกันสำหรับการค้นหาชื่อ เปลี่ยน type และ value สำหรับอีเมลหรือชื่อผู้ใช้ หรือตั้งค่า options.ai_mode และ forceToGenderize ตามที่อธิบายไว้ข้างต้น

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

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

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

**cURL**

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

```bash
curl --silent --show-error --fail-with-body --max-time 30 \
  --request POST 'https://api.genderapi.io/api/v2/gender' \
  --header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "name",
  "value": "Onur",
  "country": "TR"
}'
```

**JavaScript / Node.js**

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

```javascript
// 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 = {
  "type": "name",
  "value": "Onur",
  "country": "TR"
};

const response = await fetch("https://api.genderapi.io/api/v2/gender", {
  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.
}
```

**Python**

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

```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("{\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"}")

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",
    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.
```

**PHP**

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

```php
<?php
$apiKey = getenv('GENDERAPI_API_KEY');
if (!$apiKey) {
    throw new RuntimeException('Set GENDERAPI_API_KEY');
}
$body = json_decode('{"type":"name","value":"Onur","country":"TR"}', true, 512, JSON_THROW_ON_ERROR);

$ch = curl_init('https://api.genderapi.io/api/v2/gender');
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.
```

**Java**

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

```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 = "{\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"}";
        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"))
            .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.
    }
}
```

**C# / .NET**

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

```csharp
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");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
request.Content = new StringContent("{\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"}", 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.
}
```

**Go**

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

```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 := "{\"type\":\"name\",\"value\":\"Onur\",\"country\":\"TR\"}"
    request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/gender", 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)
    }
}
```

## คำแนะนำที่เกี่ยวข้อง

- [โหมด AI และ forceToGenderize](https://www.genderapi.io/th/docs/v2/ai-options)
- [การคาดการณ์แบบกลุ่ม](https://www.genderapi.io/th/docs/v2/batch)
- [เครดิตและการใช้งาน](https://www.genderapi.io/th/docs/v2/credits-and-usage)
- [เกิดข้อผิดพลาดและลองใหม่](https://www.genderapi.io/th/docs/v2/errors-and-retries)