رہنما
پروٹوکولز اور SDKs
OpenAI کے ساتھ ہم آہنگ، Responses اور Anthropic Messages پروٹوکولز استعمال کریں، بشمول اسٹریمنگ، ٹول کالز اور منتقلی۔
Model API تین وائر پروٹوکولز بولتا ہے۔ اپنا موجودہ SDK برقرار رکھیں اور صرف base URL، API کلید اور ماڈل ID بدلیں۔
endpoint میٹرکس
| پروٹوکول | endpoint | عام کلائنٹ |
|---|---|---|
| OpenAI Chat Completions | POST https://openapi.felo.ai/api/v1/chat/completions | OpenAI SDK، زیادہ تر OpenAI-compatible ٹولز |
| OpenAI Responses | POST https://openapi.felo.ai/api/v1/responses | OpenAI SDK بمع Responses API خصوصیات |
| Anthropic Messages | POST https://openapi.felo.ai/api/v1/messages | Anthropic SDK، Claude Code، Claude-native ٹولز |
Base URLs
| کلائنٹ | Base URL | کیوں |
|---|---|---|
| OpenAI SDK | https://openapi.felo.ai/api/v1 | SDK /chat/completions یا /responses جوڑتا ہے |
| Anthropic SDK | https://openapi.felo.ai/api | SDK /v1/messages جوڑتا ہے؛ خود /v1 نہ لگائیں |
دونوں کلائنٹس SDK API کلید کے طور پر آپ کی Felo API کلید استعمال کرتے ہیں۔
import OpenAI from "openai";
import Anthropic from "@anthropic-ai/sdk";
const openai = new OpenAI({
apiKey: process.env.FELO_API_KEY,
baseURL: "https://openapi.felo.ai/api/v1",
});
const anthropic = new Anthropic({
apiKey: process.env.FELO_API_KEY,
baseURL: "https://openapi.felo.ai/api",
});پروٹوکول منتخب کریں
- Chat Completions استعمال کریں جب آپ کا ٹول یا SDK مانوس
messagesایرے اورchoices[0].message.contentکی توقع رکھتا ہو۔ - Responses استعمال کریں جب آپ کو OpenAI کا Responses آبجیکٹ،
input،instructionsیاoutput_textدرکار ہو۔ - Messages استعمال کریں جب آپ Anthropic SDK یا Claude-native ٹول استعمال کر رہے ہوں۔
ہر پروٹوکول کے کام کرنے کا فرض کرنے سے پہلے ماڈل چیک کریں۔ کیٹلاگ supported_protocols، supported_parameters اور recommended_protocol ظاہر کرتا ہے۔ recommended_protocol کلائنٹ کے لیے ایک تجویز ہے، پابندی نہیں؛ ماڈل پھر بھی کوئی دوسرا پروٹوکول قبول کر سکتا ہے۔
اسٹریمنگ
Server-Sent Events وصول کرنے کے لیے stream: true سیٹ کریں۔
- Chat Completions OpenAI طرز کے چیٹ chunks خارج کرتا ہے۔
- Responses Responses SSE ایونٹس خارج کرتا ہے اور مکمل شدہ response آبجیکٹ پر ختم ہوتا ہے۔
- Messages Anthropic message stream ایونٹس خارج کرتا ہے۔
ایونٹ اسٹریم کو بتدریج پڑھیں اور کنکشن بند کرنے سے پہلے آخری ایونٹ سنبھالیں۔ ٹوٹا ہوا کنکشن مکمل شدہ جواب کے برابر نہیں۔
ٹول کالز اور اسٹرکچرڈ آؤٹ پٹ
tools کو پروٹوکول کی مقامی شکل میں بھیجیں۔ معاونت ماڈل کے لحاظ سے مختلف ہے، لہٰذا ٹول کالز، JSON موڈ یا اسٹرکچرڈ آؤٹ پٹ پر انحصار کرنے سے پہلے کیٹلاگ میں supported_parameters چیک کریں۔ ماڈل فیلڈ قبول کر کے بھی غیر معاون آپشن نظر انداز کر سکتا ہے۔
چینل روٹنگ
جب آپ کو کوئی فراہم کنندہ پن کرنا ہو تو تینوں endpoints X-Felo-Channel قبول کرتے ہیں۔ ہیڈر کے قواعد اور مثالوں کے لیے چینلز اور فراہم کنندہ روٹنگ دیکھیں۔
سرکاری API سے منتقلی
- base URL کو متعلقہ Felo URL میں بدلیں۔
- API کلید کو
FELO_API_KEYسے بدلیں۔ - ماڈل کا نام عوامی Felo ماڈل ID سے بدلیں۔
- درخواست کی باقی ساخت برقرار رکھیں۔
| علامت | ممکنہ وجہ |
|---|---|
| ہر درخواست پر 404 | base URL میں پہلے ہی /v1 شامل ہے، یا Anthropic base URL میں دستی طور پر /v1 لگا دیا گیا ہے |
| 401 | Felo کلید غائب ہے یا کلائنٹ اب بھی پرانی کلید بھیج رہا ہے |
400 model ایرر | ماڈل ID عوامی نہیں یا منتخب endpoint کی معاونت نہیں کرتا |
| Messages درخواست مسترد | Messages پروٹوکول میں max_tokens لازمی ہے |
| ٹول کال نظر انداز | ماڈل اُس صلاحیت کا اعلان نہیں کرتا |