Tổng quan yêu cầu
Gửi một tên trong mỗi yêu cầu
Gửi một đối tượng JSON chứa tên riêng và xác thực bằng Bearer token. Thêm mã quốc gia khi quy luật đặt tên theo khu vực có thể cải thiện kết quả dự đoán.
HTTP header bắt buộc
Xác thực yêu cầu
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYPhần thân yêu cầu JSON
Tham số
| Tham số | Kiểu | Yêu cầu | Mô tả |
|---|---|---|---|
name | string | Bắt buộc | Tên cần phân tích. Nên gửi tên riêng sạch, không kèm danh xưng hoặc tiền tố. |
country | string | Không bắt buộc | Mã quốc gia ISO 3166-1 alpha-2, chẳng hạn VN hoặc US, để bổ sung ngữ cảnh khu vực. |
askToAI | boolean | Không bắt buộc | Khi là true, dùng AI dự phòng nếu không tìm thấy tên trong cơ sở dữ liệu. |
forceToGenderize | boolean | Không bắt buộc | Khi là true, thử trả kết quả cho biệt danh hoặc dữ liệu không giống tên thông thường. |
askToAI chỉ được áp dụng khi cơ sở dữ liệu không có kết quả. Dự đoán bắt buộc cho dữ liệu bất thường có thể kém tin cậy hơn, vì vậy hãy xem probability là tín hiệu quan trọng.
Ví dụ mã
Gửi một yêu cầu đơn
Các ví dụ dưới đây gửi cùng một yêu cầu bằng xác thực Bearer.
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Linh","country":"VN","askToAI":true}'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: "Linh", country: "VN", askToAI: true })
});
const data = await response.json();import requests
response = requests.post(
"https://api.genderapi.io/api",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Linh", "country": "VN", "askToAI": True}
)
print(response.json())Phản hồi 200
Kết quả dự đoán
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Linh",
"name": "Linh",
"gender": "female",
"country": "VN",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}Các trường phản hồi
| Trường | Kiểu | Mô tả |
|---|---|---|
status | boolean | Cho biết yêu cầu có hoàn tất thành công hay không. |
used_credits | integer | Số credit đã dùng cho yêu cầu này. |
remaining_credits | integer | Số credit còn lại sau yêu cầu. |
expires | integer | Thời điểm hết hạn gói dưới dạng UNIX timestamp. |
q | string | Tên gốc được gửi trong yêu cầu. |
name | string | Tên được GenderAPI phân tích. |
gender | string | null | Giá trị dự đoán: male, female hoặc null. |
country | string | Mã quốc gia được xét khi dự đoán. |
total_names | integer | Số mẫu dữ liệu hỗ trợ dự đoán. |
probability | integer | Độ tin cậy của dự đoán theo phần trăm. |
duration | string | Thời gian xử lý trên máy chủ. |
Gửi dữ liệu sạch và được mã hóa đúng
Dùng tên riêng không kèm danh xưng hoặc tiền tố. Trình khách JSON tự xử lý mã hóa, nhưng hãy luôn kiểm tra dữ liệu bên ngoài trước khi tạo phần thân yêu cầu.
Hướng dẫn tiếp theo