API حوالہ

Base URL

ہر request یہاں جاتی ہے:

Authentication

API keys page پر key بنائیں، پھر اسے Authorization header میں bearer token کے طور پر بھیجیں۔ آپ کی key کا صرف hash store ہوتا ہے — اسے بنتے ہی copy کر لیں، کیونکہ GatifyAI اسے دوبارہ نہیں دکھا سکتا۔

Quick start

curl، Python یا TypeScript میں ایک minimal request:

curl https://gatifyai.com/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

key کو مخصوص models تک محدود کرنا

Default طور پر نئی key GatifyAI کا کوئی بھی free model استعمال کر سکتی ہے، اور اگر کوئی model دستیاب نہ ہو تو web chat جیسا ہی automatic fallover استعمال ہوتا ہے۔ آپ key کو کسی مخصوص model یا مختصر list تک بھی محدود کر سکتے ہیں — پھر key صرف اسی list کے models، آپ کے دیے ہوئے order میں، استعمال کرے گی، چاہے request کسی بھی model کا تقاضا کرے۔ اس list سے باہر model مانگنے پر 400 error آتا ہے جس میں بتایا جاتا ہے کہ key کو اصل میں کون سے models استعمال کرنے کی اجازت ہے۔

persona کے طور پر chat کرنا

community gallery میں شائع persona کے طور پر chat کرنے کے لیے model: "persona/<slug>" بھیجیں — اس کی personality اور preferred models خودکار طور پر استعمال ہوتے ہیں، پھر بھی اگر آپ نے key کے allowed models set کیے ہیں تو انہی سے محدود رہتے ہیں۔ کسی persona کا slug اور ready-made example اس کے اپنے page پر، API tab کے نیچے ملے گا۔

{
  "model": "persona/senior-engineer",
  "messages": [{"role": "user", "content": "Review my code."}]
}

Streaming vs. non-streaming

tokens بنتے ہی حاصل کرنے کے لیے stream: true set کریں، بالکل OpenAI streaming format کی طرح (Server-Sent Events، [DONE] پر ختم)۔ مکمل reply کا انتظار کر کے ایک JSON response لینے کے لیے اسے چھوڑ دیں یا false set کریں — یہی default ہے۔

Errors

Errors OpenAI error shape follow کرتے ہیں: {"error": {"message": "...", "type": "..."}}۔ 401 کا مطلب missing، invalid یا revoked key ہے۔ 400 کا مطلب request خود invalid ہے — عموماً unrecognized model، unpublished/unknown persona slug یا آپ کی key کی allowed list سے باہر model۔ 502 کا مطلب ہے کہ کسی candidate model نے respond نہیں کیا۔

{
  "error": {
    "message": "This API key may only use: llama-3.1-8b:free",
    "type": "invalid_request_error"
  }
}

Rate limits

API requests web app جیسے ہی per-account chat rate limit میں count ہوتی ہیں — آج API traffic کے لیے کوئی separate quota نہیں ہے۔