مین مواد پر جائیں

تصویر سے جنس کی API

افراد اور چہروں کی شناخت اور ہر شناخت کے لیے اعتماد کے فیصد سمیت جنس کی پیش گوئی کرنے کے لیے تصویر اپ لوڈ کریں۔

بنیادی URL​

https://api.genderrecognition.com

اینڈپوائنٹ​

POST /v1/image-gender/api

ہیڈرز​

apiKey: YOUR_API_KEY
Content-Type: multipart/form-data

درخواست کا مواد​

فیلڈقسملازمیوضاحت
filefileہاںJPEG، PNG، WebP، BMP یا GIF تصویر۔ زیادہ سے زیادہ سائز: 10 MB۔

مثال​

curl -X POST "https://api.genderrecognition.com/v1/image-gender/api" \
  -H "apiKey: YOUR_API_KEY" \
  -F "file=@people.jpg"

کامیاب جواب​

{
  "success": true,
  "detections": [
    {
      "category": "face",
      "gender": "female",
      "probability": 99
    },
    {
      "category": "person",
      "gender": "male",
      "probability": 94
    }
  ],
  "remainingRequests": 2999
}

جوابی فیلڈز​

فیلڈقسموضاحت
successbooleanتصویر کامیابی سے پراسیس ہونے پر true۔
detectionsarrayپیش گوئی کے ساتھ ہر شناخت شدہ چہرے یا غیر مربوط شخص کے لیے ایک اندراج۔
detections[].categoryface | personشخص سے منسلک چہرے کے لیے face؛ صرف جسم دستیاب ہو تو person۔
detections[].gendermale | femaleشناخت کے لیے پیش گوئی کردہ جنس۔
detections[].probabilityintegerاعتماد کا فیصد، 0 سے 100 تک۔
remainingRequestsintegerاس کامیاب درخواست کی کٹوتی کے بعد باقی API درخواستیں۔

جب چہرہ اور جسم ایک ہی شخص کے ہوں تو جواب میں چہرے اور شخص کے الگ اندراجات کے بجائے ایک face شناخت شامل ہوتی ہے۔

کوئی شناخت نہیں ہوئی​

قابل استعمال چہرہ یا شخص نہ ملنے کے باوجود پراسیسنگ کامیاب ہو سکتی ہے۔ اس صورت میں بھی ایک درخواست استعمال ہوتی ہے:

{
  "success": true,
  "detections": [],
  "remainingRequests": 2999
}

خرابی کے جوابات​

API key موجود نہیں — 401 Unauthorized​

{
  "error": "API key is required"
}

غلط API key — 404 Not Found​

{
  "error": "Invalid API key"
}

توثیق کی سروس میں خرابی — 500 Internal Server Error​

{
  "error": "Internal server error"
}

فائل موجود نہیں — 400 Bad Request​

multipart فیلڈ کا نام file ہونا چاہیے۔

{
  "error": "No file uploaded"
}

غیر متوقع multipart فیلڈ — 400 Bad Request​

یہ جواب تب آتا ہے جب اپ لوڈ کردہ فائل کا فیلڈ نام file کے بجائے کچھ اور ہو، یا ایک فائل والے فیلڈ سے ایک سے زیادہ فائلیں بھیجی جائیں۔

{
  "error": "Unexpected field"
}

فائل کی قسم غلط ہے — 400 Bad Request​

{
  "error": "Invalid file type. Allowed formats: JPEG, PNG, WEBP, BMP, GIF"
}

فائل بہت بڑی ہے — 400 Bad Request​

{
  "error": "File too large"
}

تصویر ڈی کوڈ نہیں ہو سکی — 400 Bad Request​

{
  "error": "Could not decode image"
}

اپ لوڈ کردہ تصویر غلط ہونے پر پیش گوئی کی سروس 400 کا دوسرا توثیقی پیغام بھی دے سکتی ہے۔ جواب کی ساخت { "error": "..." } ہی رہتی ہے۔

پیش گوئی کی سروس نے سائز مسترد کیا — 413 Payload Too Large​

{
  "error": "Uploaded file exceeds the 10MB size limit"
}

کوٹہ ختم ہو گیا — 400 Bad Request​

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "You have exceeded your free tier limit of 50 requests.",
    "detailedMessage": "Insufficient remaining requests. Required: 1, Available: 0",
    "details": {
      "limit": 50,
      "used": 50,
      "reset_date": "2026-07-01T00:00:00.000Z"
    },
    "suggested_action": "Please upgrade to a premium plan to continue using the API."
  }
}

معاوضے والے منصوبوں میں بھی جواب کی یہی ساخت ہوتی ہے، البتہ حد، دوبارہ ترتیب کی تاریخ اور اپ گریڈ کی ہدایات منصوبے کے مطابق ہوتی ہیں۔

پراسیسنگ کے دوران کوٹہ تبدیل ہو گیا — 400 Bad Request​

پیش گوئی سے پہلے کوٹہ جانچا جاتا ہے اور کامیاب پراسیسنگ کے بعد درخواست منہا کی جاتی ہے۔ اگر ان مراحل کے درمیان کوئی دوسری بیک وقت درخواست باقی کوٹہ استعمال کر لے تو کٹوتی یہ جواب دے سکتی ہے:

{
  "error": "Insufficient remaining requests. Required: 1, Available: 0"
}

پراسیسنگ ناکام ہوئی — 500 Internal Server Error​

{
  "error": "Image gender prediction failed"
}

اگر پیش گوئی کی بالائی سروس زیادہ مخصوص اندرونی خرابی دے تو اسی جواب کی ساخت میں اس کا پیغام error فیلڈ میں آ سکتا ہے۔

نوٹس​

  • file نامی multipart فیلڈ کے ذریعے بالکل ایک تصویر بھیجیں۔
  • درخواست صرف پیش گوئی کی سروس کے کامیاب جواب کے بعد منہا ہوتی ہے۔
  • probability مکمل عددی فیصد ہے، 0 اور 1 کے درمیان اعشاری قدر نہیں۔
  • خالی detections فہرست کامیاب نتیجہ ہے، خرابی نہیں۔
  • پیش گوئیاں ماڈل کے اندازے ہیں؛ انہیں تصدیق شدہ شناختی خصوصیات نہ سمجھیں۔