GenderAPI.io V2 के type, value, country, forceToGenderize और ai_mode फ़ील्ड का संदर्भ, GET क्वेरी और POST JSON के अंतर के साथ।
POST JSON पैरामीटर
पैरामीटर
प्रकार
ज़रूरी
डिफ़ॉल्ट
विवरण
पैरामीटरtype
प्रकारstring
ज़रूरीहाँ
डिफ़ॉल्ट—
विवरणइनपुट की श्रेणी: name, email या username।
पैरामीटरvalue
प्रकारstring
ज़रूरीहाँ
डिफ़ॉल्ट—
विवरणज़रूरी। 1–254 अक्षर; खाली नहीं और कंट्रोल कैरेक्टर के बिना। ईमेल मान मान्य ईमेल सिंटैक्स में होने चाहिए।
पैरामीटरcountry
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्ट—
विवरणवैकल्पिक, बड़े अक्षरों में ISO 3166-1 alpha-2 कोड, जैसे TR या US। देश के हिसाब से खोज में वैश्विक डेटासेट का भी इस्तेमाल हो सकता है।
पैरामीटरforceToGenderize
प्रकारboolean
ज़रूरीनहीं
डिफ़ॉल्टfalse
विवरणपहले डेटासेट आज़माएँ, फिर परिणाम न मिलने पर निकनेम समझने वाला AI। name, email और username के लिए समर्थित।
पैरामीटरoptions
प्रकारobject
ज़रूरीनहीं
डिफ़ॉल्ट—
विवरणहर इनपुट के AI विकल्पों का कंटेनर।
पैरामीटरoptions.ai_mode
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्टfallback
विवरणमान्य मान: off, fallback, always। forceToGenderize: true के साथ यह फ़ील्ड छोड़ दें या fallback इस्तेमाल करें।
पैरामीटरid
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्ट—
विवरणPOST JSON में वैकल्पिक, 1–64 अक्षरों का पहचानकर्ता। हर बैच परिणाम के साथ लौटाया जाता है; एक बैच में यूनिक होना चाहिए। एकल अनुमान में स्वीकार होता है, लेकिन लौटाया नहीं जाता। GET क्वेरी में समर्थित नहीं।
डैश (—) का मतलब है कि कोई डिफ़ॉल्ट तय नहीं है। इस्तेमाल न होने वाले वैकल्पिक इनपुट छोड़ दें; null न भेजें। रिस्पॉन्स के उदाहरण सिर्फ़ समझाने के लिए हैं, डिफ़ॉल्ट मान नहीं। Nullable का मतलब है कि फ़ील्ड में JSON null हो सकता है; छोड़े गए फ़ील्ड की जानकारी अलग से दी गई है।
जो वैकल्पिक फ़ील्ड इस्तेमाल न हों, उन्हें छोड़ दें; country या options की जगह null या खाली स्ट्रिंग न भेजें। JSON बूलियन true या false होने चाहिए, स्ट्रिंग नहीं। UTF-8 टेक्स्ट समर्थित है; नामों को ASCII में बदलने की ज़रूरत नहीं है।
GET क्वेरी पैरामीटर
पैरामीटर
प्रकार
ज़रूरी
डिफ़ॉल्ट
विवरण
पैरामीटरtype
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्टname
विवरणइनपुट की श्रेणी: name, email या username।
पैरामीटरvalue
प्रकारstring
ज़रूरीहाँ
डिफ़ॉल्ट—
विवरणज़रूरी। 1–254 अक्षर; खाली नहीं और कंट्रोल कैरेक्टर के बिना। ईमेल मान मान्य ईमेल सिंटैक्स में होने चाहिए।
पैरामीटरcountry
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्ट—
विवरणवैकल्पिक, बड़े अक्षरों में ISO 3166-1 alpha-2 कोड, जैसे TR या US। देश के हिसाब से खोज में वैश्विक डेटासेट का भी इस्तेमाल हो सकता है।
पैरामीटरforceToGenderize
प्रकारboolean
ज़रूरीनहीं
डिफ़ॉल्टfalse
विवरणपहले डेटासेट आज़माएँ, फिर परिणाम न मिलने पर निकनेम समझने वाला AI। name, email और username के लिए समर्थित।
पैरामीटरai_mode
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्टfallback
विवरणमान्य मान: off, fallback, always। forceToGenderize: true के साथ यह फ़ील्ड छोड़ दें या fallback इस्तेमाल करें।
पैरामीटरkey
प्रकारstring
ज़रूरीनहीं
डिफ़ॉल्ट—
विवरणGET अनुरोधों के लिए मौजूदा API कुंजी। Authorization हेडर बेहतर है; कुंजी न होने या पहचानी न जाने पर IP ट्रायल इस्तेमाल होता है।
GET में type, value, country, forceToGenderize और ai_mode सीधे क्वेरी स्ट्रिंग में जाते हैं, साथ में वैकल्पिक key भी। मानों को अपने HTTP क्लाइंट के URL पैरामीटर एनकोडर से एनकोड करें; उदाहरण के लिए @ बदलकर %40 हो जाता है। GET में बूलियन के लिए true या false भेजें। अज्ञात फ़ील्ड और अमान्य मान अस्वीकार कर दिए जाते हैं।
अनुरोध भेजने से पहले
POST https://api.genderapi.io/api/v2/gender पर JSON भेजें। Authorization: Bearer YOUR_API_KEY में अपनी मौजूदा API कुंजी और Content-Type: application/json इस्तेमाल करें। हर अनुरोध अलग से प्रोसेस होता है।
कोड उदाहरण में अपनी प्रोग्रामिंग भाषा चुनें। चलाने से पहले प्रोसेस एनवायरनमेंट में GENDERAPI_API_KEY सेट करें। कुंजी न होने या पहचानी न जाने पर साझा IP ट्रायल इस्तेमाल हो सकता है, इसलिए अकाउंट इंटीग्रेट करते समय पक्का करें कि meta.access.mode का मान api_key है।
यह उदाहरण नाम के अनुरोध के लिए साझा अनुरोध फ़ील्ड इस्तेमाल करता है। ईमेल या यूज़रनेम के लिए 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 देखें।
// 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": "Rahul", "country": "IN"};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.}
Node.js 22+; बिल्ट-इन fetch। example.mjs के रूप में सेव करें और node example.mjs चलाएँ। रनटाइम दस्तावेज़ीकरण
Python
import jsonimport osimport sysimport urllib.errorimport urllib.requestapi_key = os.environ.get("GENDERAPI_API_KEY")if not api_key: raise RuntimeError("Set GENDERAPI_API_KEY")body = json.loads("{\"type\":\"name\",\"value\":\"Rahul\",\"country\":\"IN\"}")class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return Nonerequest = 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.
Python 3.10+; स्टैंडर्ड लाइब्रेरी। example.py के रूप में सेव करें और python3 example.py चलाएँ। रनटाइम दस्तावेज़ीकरण
cURL एक्सटेंशन के साथ PHP 8+। 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 = "{\"type\":\"name\",\"value\":\"Rahul\",\"country\":\"IN\"}"; 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. }}
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");request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);request.Content = new StringContent("{\"type\":\"name\",\"value\":\"Rahul\",\"country\":\"IN\"}", 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 mainimport ( "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\":\"Rahul\",\"country\":\"IN\"}" 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) }}
Go 1.22+; स्टैंडर्ड लाइब्रेरी। main.go के रूप में सेव करें और go run main.go चलाएँ। रनटाइम दस्तावेज़ीकरण