شروع
شروع
یک کلید API بگیرید، یک ابزار AI انتخاب کنید، راهنمای راهاندازی آن را باز کنید و اولین فراخوانی API جریان کاری خود را اجرا کنید.
Felo API Platform یک کلید برای ابزارهای عامل، پروتکلهای مدل و APIهای Search، Web Fetch، PPT، Mindmap، LiveDocs، X Search، YouTube Subtitling، Landing Page و SuperAgent در اختیار شما میگذارد. از همینجا شروع کنید، ابزاری را که به کار میبرید انتخاب کنید و سپس راهنمای راهاندازی اختصاصی همان ابزار را دنبال کنید.
تازهوارد هستید؟ مرور پلتفرم را بخوانید تا ببینید Model API، Data API و Felo APIها چگونه در کنار هم قرار میگیرند، یا مستقیم به پروتکلها و SDKها و کانالها و مسیریابی ارائهدهنده بروید.
پیکربندی Codex یا Claude Code با CLI
با Node.js 22+ و ابزار هوش مصنوعی نصبشده، این را اجرا کنید:
npx feloapi-cli setupدستورهای راهنما را دنبال کنید تا کلید کامل Felo API را جایگذاری کنید و مدلها، Skillها یا هر دو را انتخاب کنید. سپس ابزار خود را با npx feloapi-cli run codex یا npx feloapi-cli run claude-code شروع کنید.
جریان شروع سریع
- یک کلید Felo API Platform بگیرید و در صورت نیاز اعتبار سرویس بخرید؛ اشتراک لازم نیست.
- ابزار یا پلتفرم هوش مصنوعی خود را از جدول زیر انتخاب کنید.
- راهنمای راهاندازی متناظر را باز کنید و base URL و کلید API Felo را جایگذاری کنید.
- یک وظیفه کوچک در آن ابزار اجرا کنید تا اتصال را تأیید کنید.
- وقتی عامل شما به جستجو، خروجی اداری، استخراج وب، گردشکارهای تصویر، LiveDocs یا SuperAgent نیاز داشت، APIهای گردشکار را اضافه کنید.
گام 1: دریافت کلید API
Felo API Platform یک کلید API را در فراخوانیهای مستقیم API و ابزارهای هوش مصنوعی پشتیبانیشده به کار میبرد.
- صفحه API Keys در Felo API Platform را باز کنید.
- اگر خواسته شد با حساب Felo خود وارد شوید.
- یک نام برای کلید وارد کنید و روی Create Key کلیک کنید.
- وقتی کلید کامل نمایش داده شد آن را کپی کنید. کلید فقط یک بار نشان داده میشود.
- کلید را امن نگه دارید و آن را بهعنوان
FELO_API_KEYبه کار ببرید.
هر زمان لازم شد در Console Billing از $1 شارژ کنید. شما اعتبار سرویس به دلار آمریکا برای مصرف واقعی API میخرید. اشتراک لازم نیست.
کلید را بهعنوان متغیر محیطی تنظیم کنید:
export FELO_API_KEY="YOUR_API_KEY"Windows PowerShell:
$env:FELO_API_KEY="YOUR_API_KEY"گام 2: انتخاب ابزار هوش مصنوعی
روی ابزاری که میخواهید به کار ببرید کلیک کنید. هر پیوند راهنمای راهاندازی اختصاصی با base URL درست، متغیرهای محیطی و گام بررسی را باز میکند.
| ابزار | مناسب برای | راهنمای راهاندازی |
|---|---|---|
| Codex | گردشکارهای کدنویسی CLI، بازبینی کد، تغییر مخزن و خودکارسازی | راهاندازی Codex |
| Claude Code | کدنویسی عامل، ویرایش مخزن، توسعه با کمک پژوهش و کار با زمینه بلند | راهاندازی Claude Code |
| OpenCode | نشستهای کدنویسی در ترمینال و مسیریابی ارائهدهنده سازگار با OpenAI | راهاندازی OpenCode |
| OpenClaw | گردشکارهای دستیار هوش مصنوعی شخصی و عاملهای محلی | راهاندازی OpenClaw |
| Hermes Agent | آزمایشهای عامل و هماهنگی چندابزاری | راهاندازی Hermes Agent |
| TRAE | گردشکارهای AI IDE و ویرایش با کمک هوش مصنوعی | راهاندازی TRAE |
| OpenViking | آزمایشهای عامل و جابهجایی ارائهدهنده | راهاندازی OpenViking |
| Cursor | کدنویسی با هوش مصنوعی در ویرایشگر | راهاندازی Cursor |
| Cline | گردشکارهای عامل در VS Code و کدنویسی با کمک ترمینال | راهاندازی Cline |
| Roo Code | عاملهای کدنویسی در VS Code و برنامهریزی وظیفه | راهاندازی Roo Code |
| Kilo Code | عاملهای کدنویسی محلی و آزمون ارائهدهنده مدل | راهاندازی Kilo Code |
| سایر ابزارهای هوش مصنوعی | هر کلاینتی که کلید API سفارشی، base URL و نام مدل را بپذیرد | راهاندازی ابزارهای دیگر |
گام 3: استفاده از base URL درست
بیشتر ابزارها سه مقدار میخواهند: کلید API، base URL و نام مدل. base URL را بر پایه پروتکلی که ابزار پشتیبانی میکند انتخاب کنید.
| ابزار این را میخواهد | این مقدار را به کار ببرید |
|---|---|
| کلید API | FELO_API_KEY شما |
| base URL سازگار با OpenAI | https://openapi.felo.ai/api/v1 |
| base URL سازگار با Anthropic | https://openapi.felo.ai/api |
| شناسه مدل | یک شناسه در دسترس را از کاتالوگ مدل انتخاب کنید |
اگر مطمئن نیستید کلاینت شما کدام حالت را پشتیبانی میکند، با base URL سازگار با OpenAI شروع کنید. برای Claude Code یا کلاینتی که صریحاً endpoint سازگار با Anthropic Messages میخواهد، از base URL سازگار با Anthropic استفاده کنید.
گام 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"
}'پاسخ موفق شامل یک پاسخ، تحلیل پرسش و منابع وب است.
{
"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: افزودن APIهای گردشکار
پس از آنکه نخستین ابزار یا فراخوانی API کار کرد، APIهایی را که با سناریوی شما همخوانی دارند وصل کنید.
| سناریو | APIهای پیشنهادی | مستندات |
|---|---|---|
| عامل جستجو و پژوهش | 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 |
| برنامه هوش مصنوعی تمامپشته | LLM API، Chat، LiveDocs، Web Fetch، SuperAgent | LLM API |
| گردشکار دانش | LiveDocs، Web Fetch، Chat، SuperAgent | LiveDoc API |
نمونههای مستقیم API
اگر بهجای پیکربندی یک ابزار هوش مصنوعی مستقیم روی API برنامه میسازید، با یکی از این فراخوانیهای کمینه شروع کنید.
ساخت یک PPT Task
وقتی میخواهید مجموعه اسلاید را بهصورت ناهمگام تولید کنید از 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"ساخت یک Landing Page Task
وقتی میخواهید Felo از یک اعلان (prompt) یک صفحه فرود بسازد از 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 taskها به کار میبرند بپرسید:
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 در workspace یا نشست جاری انتخاب شده است |
| کلاینت سازگار با OpenAI شکست میخورد | از https://openapi.felo.ai/api/v1 بهعنوان base URL استفاده کنید |
| کلاینت سازگار با Anthropic شکست میخورد | از https://openapi.felo.ai/api بهعنوان base URL استفاده کنید |
| وظیفه ناهمگام هنوز نتیجهای ندارد | endpoint وضعیت وظیفه را تا کاملشدن وظیفه پیوسته بپرسید |