ภาพรวมคำขอ
ส่งหนึ่งชื่อต่อหนึ่งคำขอ
ส่งออบเจ็กต์ JSON ที่มีชื่อและยืนยันตัวตนด้วย Bearer token หากรูปแบบการใช้ชื่อในแต่ละภูมิภาคช่วยเพิ่มคุณภาพ การทำนาย ให้เพิ่มรหัสประเทศ
วิธีPOST
ชนิดเนื้อหาapplication/json
การยืนยันตัวตนBearer token
เครดิตที่ใช้1 การค้นหา
HDR
HTTP header ที่จำเป็น
ยืนยันตัวตนของคำขอ
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYเก็บ API key ไว้ในตัวแปรสภาพแวดล้อมของเซิร์ฟเวอร์ สำหรับการจัดการข้อมูลรับรองอย่างปลอดภัย โปรดดู คู่มือการยืนยันตัวตน
เนื้อหาคำขอ JSON
พารามิเตอร์
| พารามิเตอร์ | ชนิด | ข้อกำหนด | คำอธิบาย |
|---|---|---|---|
name | string | จำเป็น | ชื่อที่ต้องการวิเคราะห์ ส่งเฉพาะช่องชื่อโดยไม่ใส่คำนำหน้าหรือคำเรียก |
country | string | ไม่บังคับ | เพิ่มบริบทตามภูมิภาคด้วยรหัสประเทศ ISO 3166-1 alpha-2 เช่น TH หรือ US |
askToAI | boolean | ไม่บังคับ | เมื่อเป็น true ระบบจะใช้ AI ช่วยวิเคราะห์หากไม่พบชื่อในฐานข้อมูล |
forceToGenderize | boolean | ไม่บังคับ | เมื่อเป็น true ระบบจะพยายามทำนายแม้เป็นชื่อเล่นหรือข้อความที่ดูไม่เหมือนชื่อทั่วไป |
ข้อมูลเกี่ยวกับ AI เสริม
ระบบใช้ askToAI เฉพาะเมื่อไม่พบผลลัพธ์ในฐานข้อมูล การบังคับทำนายข้อมูลที่ผิดปกติอาจมี ความเชื่อมั่นต่ำ จึงควรใช้ probability เป็นสัญญาณคุณภาพสำคัญ
ตัวอย่างโค้ด
ส่งคำขอเดียว
ตัวอย่างทั้งหมดส่งคำขอเดียวกันโดยใช้ Bearer authentication
cURL
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Araya","country":"TH","askToAI":true}'JavaScript
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: "Araya", country: "TH", askToAI: true })
});
const data = await response.json();Python
import requests
response = requests.post(
"https://api.genderapi.io/api",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Araya", "country": "TH", "askToAI": True}
)
print(response.json())ผลลัพธ์ 200
ผลการทำนายเพศ
JSON
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Araya",
"name": "Araya",
"gender": "female",
"country": "TH",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}ฟิลด์ผลลัพธ์
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
status | boolean | ระบุว่าคำขอได้รับการประมวลผลโดยไม่มีข้อผิดพลาดหรือไม่ |
used_credits | integer | จำนวนเครดิตที่ใช้กับคำขอ |
remaining_credits | integer | จำนวนเครดิตที่เหลือหลังประมวลผลคำขอ |
expires | integer | UNIX timestamp ของเวลาที่แพ็กเกจหมดอายุ |
q | string | ชื่อเดิมที่ส่งมากับคำขอ |
name | string | ชื่อที่ GenderAPI วิเคราะห์ |
gender | string | null | ผลการทำนายเป็น male, female หรือ null |
country | string | รหัสประเทศที่ใช้ในการทำนาย |
total_names | integer | จำนวนระเบียนชื่อที่ใช้เป็นข้อมูลอ้างอิงในการทำนาย |
probability | integer | ค่าความเชื่อมั่นของการทำนายเป็นเปอร์เซ็นต์ |
duration | string | ระยะเวลาประมวลผลของเซิร์ฟเวอร์ |
ส่งข้อมูลที่สะอาดและเข้ารหัสอย่างถูกต้อง
ใช้เฉพาะชื่อโดยไม่ใส่คำนำหน้าหรือคำเรียก แม้ไคลเอนต์ JSON จะจัดการการเข้ารหัสให้อัตโนมัติ ก็ควรตรวจสอบ ข้อมูลจากภายนอกทุกครั้งก่อนสร้างเนื้อหาคำขอ
คู่มือถัดไป