آغاز
آغاز
ایک API کلید حاصل کریں، ایک AI ٹول منتخب کریں، اس کی سیٹ اپ گائیڈ کھولیں، اور اپنے ورک فلو کی پہلی API کال چلائیں۔
Felo API Platform آپ کو ایجنٹ ٹولز، ماڈل پروٹوکولز، Search، Web Fetch، PPT، Mindmap، LiveDocs، X Search، YouTube Subtitling، Landing Page اور SuperAgent APIs کے لیے ایک ہی کلید دیتا ہے۔ یہیں سے شروع کریں، اپنا استعمال کردہ ٹول منتخب کریں، پھر اُس ٹول کی مخصوص سیٹ اپ گائیڈ کی پیروی کریں۔
پہلی بار آئے ہیں؟ Platform کا جائزہ پڑھیں تاکہ سمجھ سکیں کہ Model API، Data API اور Felo APIs کیسے باہم جڑتے ہیں، یا سیدھا پروٹوکولز اور SDKs اور چینلز اور فراہم کنندہ روٹنگ پر جائیں۔
CLI کے ذریعے Codex یا Claude Code کنفیگر کریں
Node.js 22+ اور اپنا AI ٹول انسٹال ہونے کے بعد یہ چلائیں:
npx feloapi-cli setupہدایات پر عمل کرتے ہوئے اپنی مکمل Felo API کلید پیسٹ کریں اور ماڈلز، Skills یا دونوں منتخب کریں۔ پھر اپنا ٹول npx feloapi-cli run codex یا npx feloapi-cli run claude-code سے شروع کریں۔
فوری آغاز کا بہاؤ
- Felo API Platform کی کلید حاصل کریں اور ضرورت پڑنے پر سروس کریڈٹ خریدیں؛ کسی سبسکرپشن کی ضرورت نہیں۔
- نیچے دیے گئے جدول سے اپنا AI ٹول یا پلیٹ فارم منتخب کریں۔
- متعلقہ سیٹ اپ گائیڈ کھولیں اور Felo base URL اور API کلید پیسٹ کریں۔
- تصدیق کے لیے اُس ٹول میں کوئی چھوٹا کام چلائیں۔
- جب آپ کے ایجنٹ کو سرچ، آفس آؤٹ پٹ، ویب ایکسٹریکشن، تصویری ورک فلوز، LiveDocs یا SuperAgent درکار ہو تو متعلقہ ورک فلو APIs شامل کریں۔
مرحلہ 1: اپنی API کلید حاصل کریں
Felo API Platform براہ راست API کالز اور معاون AI ٹولز میں ایک ہی API کلید استعمال کرتا ہے۔
- Felo API Platform API Keys صفحہ کھولیں۔
- اگر کہا جائے تو اپنے Felo اکاؤنٹ سے سائن اِن کریں۔
- کلید کا نام درج کریں اور Create Key پر کلک کریں۔
- کلید ظاہر ہونے پر مکمل کاپی کریں۔ یہ صرف ایک بار دکھائی جاتی ہے۔
- کلید کو محفوظ طریقے سے رکھیں اور
FELO_API_KEYکے طور پر استعمال کریں۔
Console Billing میں $1 سے شروع کر کے جتنی ضرورت ہو ٹاپ اپ کریں۔ آپ اصل API استعمال کے لیے USD میں سروس کریڈٹ خریدتے ہیں۔ کسی سبسکرپشن کی ضرورت نہیں۔
کلید کو environment variable کے طور پر سیٹ کریں:
export FELO_API_KEY="YOUR_API_KEY"Windows PowerShell:
$env:FELO_API_KEY="YOUR_API_KEY"مرحلہ 2: اپنا AI ٹول منتخب کریں
جس ٹول کو استعمال کرنا چاہتے ہیں اُس پر کلک کریں۔ ہر لنک ایک مخصوص سیٹ اپ گائیڈ کھولتا ہے جس میں درست base URL، environment variables اور تصدیق کا مرحلہ موجود ہے۔
| ٹول | بہترین برائے | سیٹ اپ گائیڈ |
|---|---|---|
| Codex | CLI کوڈنگ ورک فلوز، کوڈ ریویو، ریپو میں تبدیلیاں اور آٹومیشن | Codex سیٹ اپ کریں |
| Claude Code | ایجنٹ کوڈنگ، ریپو ایڈیٹنگ، تحقیق کی مدد سے ڈویلپمنٹ اور طویل سیاق و سباق کا کام | Claude Code سیٹ اپ کریں |
| OpenCode | ٹرمینل کوڈنگ سیشنز اور OpenAI-compatible فراہم کنندہ روٹنگ | OpenCode سیٹ اپ کریں |
| OpenClaw | ذاتی AI اسسٹنٹ ورک فلوز اور مقامی ایجنٹس | OpenClaw سیٹ اپ کریں |
| Hermes Agent | ایجنٹ تجربات اور متعدد ٹولز کی آرکسٹریشن | Hermes Agent سیٹ اپ کریں |
| TRAE | AI IDE ورک فلوز اور معاون ایڈیٹنگ | TRAE سیٹ اپ کریں |
| OpenViking | ایجنٹ تجربات اور فراہم کنندہ کی تبدیلی | OpenViking سیٹ اپ کریں |
| Cursor | ایڈیٹر کے اندر AI کوڈنگ | Cursor سیٹ اپ کریں |
| Cline | VS Code ایجنٹ ورک فلوز اور ٹرمینل کی مدد سے کوڈنگ | Cline سیٹ اپ کریں |
| Roo Code | VS Code کوڈنگ ایجنٹس اور ٹاسک پلاننگ | Roo Code سیٹ اپ کریں |
| Kilo Code | مقامی کوڈنگ ایجنٹس اور ماڈل فراہم کنندہ کی جانچ | Kilo Code سیٹ اپ کریں |
| دیگر AI ٹولز | کوئی بھی کلائنٹ جو حسب ضرورت API کلید، base URL اور ماڈل کا نام قبول کرے | دیگر ٹولز سیٹ اپ کریں |
مرحلہ 3: درست base URL استعمال کریں
زیادہ تر ٹولز تین ویلیوز طلب کرتے ہیں: API کلید، base URL اور ماڈل کا نام۔ base URL اُس پروٹوکول کی بنیاد پر منتخب کریں جس کی ٹول معاونت کرتا ہے۔
| ٹول جو طلب کرتا ہے | یہ ویلیو استعمال کریں |
|---|---|
| API کلید | آپ کی FELO_API_KEY |
| OpenAI-compatible base URL | https://openapi.felo.ai/api/v1 |
| Anthropic-compatible base URL | https://openapi.felo.ai/api |
| ماڈل ID | ماڈل کیٹلاگ سے کوئی فی الحال دستیاب ID منتخب کریں |
اگر آپ کو یقین نہ ہو کہ آپ کا کلائنٹ کون سا موڈ معاونت کرتا ہے تو OpenAI-compatible base URL سے آغاز کریں۔ Claude Code یا اُن کلائنٹس کے لیے Anthropic-compatible base URL استعمال کریں جو واضح طور پر Anthropic Messages endpoint طلب کرتے ہیں۔
مرحلہ 4: براہ راست API کال سے تصدیق کریں
اگر آپ صرف یہ یقینی بنانا چاہتے ہیں کہ آپ کی کلید کام کرتی ہے تو Chat API کو براہ راست کال کریں۔
curl -X POST https://openapi.felo.ai/v2/chat \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "Research the latest AI agent product trends"
}'کامیاب جواب میں ایک answer، query analysis اور web resources شامل ہوتے ہیں۔
{
"status": "ok",
"data": {
"id": "HabCj883yHLSXc8mWqu4Eq",
"message_id": "18ea8517-5559-4f48-a355-1f8a79e73b71",
"answer": "...",
"query_analysis": {
"queries": ["AI agent product trends"]
},
"resources": [
{
"link": "https://example.com/report",
"title": "AI Agent Market Report",
"snippet": "..."
}
]
}
}مرحلہ 5: ورک فلو APIs شامل کریں
آپ کے پہلے ٹول یا API کال کے کامیاب ہونے کے بعد اُن APIs کو جوڑیں جو آپ کے منظر نامے سے مطابقت رکھتے ہوں۔
| منظر نامہ | تجویز کردہ APIs | دستاویزات |
|---|---|---|
| سرچ اور ریسرچ ایجنٹ | Chat، Web Fetch، X Search، YouTube Subtitling، LiveDocs | Chat API |
| آفس پروڈکٹیویٹی ایجنٹ | PPT Task، Mindmap، LiveDocs، SuperAgent | PPT Task API |
| کریٹیو آپریشنز ایجنٹ | Landing Page، تصویری ورک فلوز، Web Fetch، Search، SuperAgent | Landing Page API |
| فل اسٹیک AI ایپ | LLM API، Chat، LiveDocs، Web Fetch، SuperAgent | LLM API |
| نالج ورک فلو | LiveDocs، Web Fetch، Chat، SuperAgent | LiveDoc API |
براہ راست API کی مثالیں
اگر آپ AI ٹول کنفیگر کرنے کے بجائے براہ راست API کے خلاف تعمیر کر رہے ہیں تو اِن میں سے کسی کم سے کم کال سے آغاز کریں۔
PPT ٹاسک بنائیں
جب آپ غیر ہم وقت (asynchronously) سلائیڈ ڈیک بنانا چاہیں تو PPT Task API استعمال کریں۔ جواب میں ایک task_id ملتا ہے جسے آپ پول کر سکتے ہیں۔
curl -X POST https://openapi.felo.ai/v2/ppts \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "Create a 5-slide strategy deck about AI agents for office productivity"
}'جواب کی مثال:
{
"status": "ok",
"message": null,
"data": {
"task_id": "019cad6d-e874-55ef-d577-686344b5a7e9",
"livedoc_short_id": "PvyKouzJirXjFdst4uKRK3",
"ppt_business_id": "BfLPuQKmChk9SPmyQawxgr"
}
}ٹاسک کی حالت پول کریں:
curl -X GET https://openapi.felo.ai/v2/tasks/019cad6d-e874-55ef-d577-686344b5a7e9/status \
-H "Authorization: Bearer $FELO_API_KEY"لینڈنگ پیج ٹاسک بنائیں
جب آپ چاہتے ہیں کہ Felo کسی پرامپٹ سے لینڈنگ پیج بنائے تو Landing Page Task API استعمال کریں۔
curl -X POST https://openapi.felo.ai/v2/landing_page \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "Generate a launch landing page for an AI research assistant"
}'جواب کی مثال:
{
"status": "ok",
"message": null,
"data": {
"task_id": "019cad6d-e874-55ef-d577-686344b5a7e9",
"thread_short_id": "9qiLTmT77fA3aVurrMHvRJ"
}
}وہی ٹاسک اسٹیٹس endpoint پول کریں جو PPT ٹاسکس استعمال کرتے ہیں:
curl -X GET https://openapi.felo.ai/v2/tasks/019cad6d-e874-55ef-d577-686344b5a7e9/status \
-H "Authorization: Bearer $FELO_API_KEY"Python
import os
import requests
api_key = os.environ["FELO_API_KEY"]
response = requests.post(
"https://openapi.felo.ai/v2/chat",
headers={
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json",
},
json={"query": "What are the latest AI agent product trends?"},
timeout=60,
)
response.raise_for_status()
print(response.json()["data"]["answer"])JavaScript (Node.js)
const response = await fetch("https://openapi.felo.ai/v2/chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.FELO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
query: "What are the latest AI agent product trends?",
}),
});
if (!response.ok) {
throw new Error(`Felo API request failed: ${response.status}`);
}
const result = await response.json();
console.log(result.data.answer);سیٹ اپ کے عام مسائل
| مسئلہ | کیا چیک کریں |
|---|---|
UNAUTHORIZED | تصدیق کریں کہ کلید درست طریقے سے کاپی ہوئی ہے، منسوخ نہیں ہوئی اور Authorization: Bearer $FELO_API_KEY کے طور پر بھیجی جا رہی ہے |
| ٹول غلط فراہم کنندہ کو کال کرتا ہے | چیک کریں کہ موجودہ ورک اسپیس یا سیشن میں Felo فراہم کنندہ منتخب ہے |
| OpenAI-compatible کلائنٹ ناکام ہوتا ہے | base URL کے طور پر https://openapi.felo.ai/api/v1 استعمال کریں |
| Anthropic-compatible کلائنٹ ناکام ہوتا ہے | base URL کے طور پر https://openapi.felo.ai/api استعمال کریں |
| async ٹاسک کا نتیجہ ابھی نہیں آیا | ٹاسک مکمل ہونے تک ٹاسک اسٹیٹس endpoint پول کریں |