नाम से जेंडर प्राप्त करें - एकल अनुरोध
नाम से जेंडर प्राप्त करें एंडपॉइंट आपको एकल पहले नाम के आधार पर लिंग निर्धारित करने की सुविधा देता है। सभी पैरामीटर एक POST अनुरोध के माध्यम से JSON के रूप में भेजे जाते हैं। आपको Authorization हेडर में Bearer टोकन विधि का उपयोग करके प्रमाणीकरण करना आवश्यक है।
अनुरोध URL
POST https://api.genderapi.io/api
आवश्यक HTTP हेडर
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
रिक्वेस्ट बॉडी पैरामीटर
पैरामीटर | टाइप | आवश्यक | विवरण |
---|---|---|---|
name | String | हाँ | वह पहला नाम जिसे आप विश्लेषित करना चाहते हैं। यह एक शब्द होना चाहिए, बिना किसी टाइटल या उपसर्ग के। |
country | String | नहीं |
दो-अक्षर का देश कोड (ISO 3166-1 alpha-2) सटीकता बढ़ाने के लिए।
उदाहरण: TR तुर्की के लिए।
|
askToAI | Boolean | नहीं |
यदि true सेट है, तो API डेटाबेस में नाम न मिलने पर AI मॉडल से जेंडर पूछेगा।
|
forceToGenderize | Boolean | नहीं |
यदि true सेट है, तो API ऐसे इनपुट के लिए भी लिंग का अनुमान लगाने का प्रयास करेगा जो सामान्य मानव नाम नहीं हैं,
जैसे उपनाम या फैंटेसी शब्द (जैसे sparkling unicorn )।
|
अनुरोध के उदाहरण
cURL उदाहरण
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name": "Alice", "country": "US", "askToAI": true, "forceToGenderize": true}'
PHP cURL उदाहरण
<?php
$url = "https://api.genderapi.io/api";
$data = array(
"name" => "Alice",
"country" => "US",
"askToAI" => true,
"forceToGenderize" => true
);
$payload = json_encode($data);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"Content-Type: application/json",
"Authorization": "Bearer YOUR_API_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
JavaScript fetch उदाहरण
fetch("https://api.genderapi.io/api", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
name: "Alice",
country: "US",
askToAI: true,
forceToGenderize: true
})
})
.then(response => response.json())
.then(data => console.log(data));
Python requests उदाहरण
import requests
url = "https://api.genderapi.io/api"
payload = {
"name": "Alice",
"country": "US",
"askToAI": True,
"forceToGenderize": True
}
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
JSON प्रतिक्रिया का उदाहरण
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "Alice",
"gender": "female",
"country": "US",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}
प्रतिक्रिया फ़ील्ड्स
फ़ील्ड | टाइप | विवरण |
---|---|---|
status | Boolean | अनुरोध सफल था या नहीं, यह दर्शाता है। |
used_credits | Integer | इस अनुरोध में कितने क्रेडिट्स उपयोग हुए। |
remaining_credits | Integer | इस अनुरोध के बाद आपके खाते में शेष क्रेडिट्स। |
expires | Integer (timestamp) | पैकेज की समाप्ति तिथि UNIX timestamp के रूप में। |
q | String | आपकी इनपुट क्वेरी (जमा किया गया नाम)। |
name | String | विश्लेषित या निकाला गया पहला नाम। |
gender | Enum[String] | अनुमानित जेंडर। संभावित मान: male , female या null । |
country | String | पूर्वानुमान के दौरान उपयोग किया गया देश कोड। |
total_names | Integer | इस पूर्वानुमान के लिए उपयोग किए गए नमूनों की संख्या। |
probability | Integer | जेंडर पूर्वानुमान के लिए विश्वास प्रतिशत। |
duration | String | अनुरोध को संसाधित करने में लिया गया समय (उदा. 4ms )। |
चेतावनी:
सुनिश्चित करें कि इनपुट मान जैसे नामों में कोई अप्रत्याशित अक्षर न हों।
यदि आप विशेष वर्ण या स्पेस का उपयोग करते हैं, तो त्रुटियों से बचने के लिए उचित JSON एन्कोडिंग का उपयोग करें।