# API v2 अनुरोध पैरामीटर

> GenderAPI V2 के type, value, country, forceToGenderize और ai_mode फ़ील्ड की जानकारी, साथ में GET क्वेरी और POST JSON बॉडी के बीच अंतर।

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

Last reviewed: 2026-09-25

## एकल पूर्वानुमान पैरामीटर

अप्रयुक्त होने पर वैकल्पिक फ़ील्ड छोड़े जाने चाहिए; country या options के स्थान पर null या खाली स्ट्रिंग न भेजें। JSON बूलियन true या false होना चाहिए, स्ट्रिंग नहीं। UTF-8 टेक्स्ट समर्थित है; नामों को ASCII में लिप्यंतरित करने की आवश्यकता नहीं है।

GET सीधे क्वेरी स्ट्रिंग में type, value, country, forceToGenderize और ai_mode का उपयोग करता है, साथ ही वैकल्पिक key का भी उपयोग करता है। अपने HTTP क्लाइंट के URL पैरामीटर एनकोडर के साथ मान एनकोड करें; उदाहरण के लिए @ %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 है। सबसे पहले, डेटासेट खोजें। यदि कोई लिंग निर्धारित नहीं किया जा सकता है, तो उपनाम की व्याख्या करने के लिए एआई का उपयोग करें। सभी तीन इनपुट प्रकारों के लिए समर्थित। |
| options.ai_mode | string | off, fallback या always। एकल अनुरोधों के लिए डिफ़ॉल्ट fallback और बैच आइटम के लिए off है। |
| id | string | POST JSON बॉडी में 1-64 वर्णों वाला वैकल्पिक पहचानकर्ता। यह एक बैच के भीतर अद्वितीय होना चाहिए और इसके बैच परिणाम के साथ लौटाया जाना चाहिए। एकल अनुरोध इस पहचानकर्ता को स्वीकार करते हैं लेकिन इसे प्रतिक्रिया में शामिल नहीं करते हैं। GET क्वेरीज़ इसका समर्थन नहीं करतीं. |

## अनुरोध भेजने से पहले

JSON को POST https://api.genderapi.io/api/v2/gender पर भेजें। Authorization: Bearer YOUR_API_KEY और Content-Type: application/json में अपनी मौजूदा API कुंजी का उपयोग करें। प्रत्येक अनुरोध को स्वतंत्र रूप से संसाधित किया जाता है।

कोड उदाहरण में अपनी भाषा चुनें. इसे चलाने से पहले प्रक्रिया वातावरण में GENDERAPI_API_KEY सेट करें। गुम या अपरिचित कुंजियाँ साझा IP परीक्षण का उपयोग कर सकती हैं, इसलिए किसी खाते को एकीकृत करते समय पुष्टि करें कि meta.access.mode api_key है।

- [प्रमाणीकरण और परीक्षण पहुंच](https://www.genderapi.io/hi/docs/v2/authentication)
- [सभी अनुरोध पैरामीटर](https://www.genderapi.io/hi/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**

POSIX शेल में cURL 7.76+. अपने टर्मिनल में चलाएँ.

```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/hi/docs/v2/ai-options)
- [बैच की भविष्यवाणियाँ](https://www.genderapi.io/hi/docs/v2/batch)
- [क्रेडिट और उपयोग](https://www.genderapi.io/hi/docs/v2/credits-and-usage)
- [त्रुटियाँ और पुनः प्रयास](https://www.genderapi.io/hi/docs/v2/errors-and-retries)