شروع سریع

از قبل از یک API استفاده می‌کنید؟ Base URL و کلید API را جایگزین کنید. این تنظیمات اتصال را در دسترس نگه دارید.

کلید خود را تنظیم کنید

دریافت کلید API

export FELO_API_KEY="YOUR_FELO_API_KEY"

احراز هویت درخواست: Authorization: Bearer $FELO_API_KEY

Model API

SDK فعلی خود را نگه دارید. Base URL رسمی را با نشانی متناظر Felo جایگزین کنید.

OpenAI · Chat Completions / Responses

جایگزینی https://api.openai.com/v1

https://openapi.felo.ai/api/v1

Anthropic · Messages

جایگزینی https://api.anthropic.com

https://openapi.felo.ai/api

SDKهای Anthropic مسیر /v1/messages را اضافه می‌کنند. Base URL را روی /api تنظیم کنید، بدون /v1 در انتها. از کلید Felo به‌عنوان کلید API مربوط به SDK استفاده کنید.

مرجع Model API

Data API Beta

یک کلید Felo برای ارائه‌دهندگان Data API. پیشوند مشترک را به‌کار ببرید و سپس مسیر endpoint را اضافه کنید.

پیشوند مشترک

https://openapi.felo.ai/v1/beta

نشانی کامل درخواست

https://openapi.felo.ai/v1/beta/{provider}/{endpoint}

روش و مسیر را از مرجع endpoint کپی کنید. مسیرهایی که با /v1/beta شروع می‌شوند از قبل پیشوند را دارند؛ آن را دو بار اضافه نکنید. بدنه‌های درخواست مخصوص هر ارائه‌دهنده همچنان اعمال می‌شوند.

مرجع Data API نمای کلی Data API

این‌ها نشانی‌های API محیط تولید هستند. برای محیط آزمایشی، فقط نام میزبان را به openapi-dev.felo.ai تغییر دهید.

کلید خود را بررسی کنید و مدل‌ها را فهرست کنید

curl https://openapi.felo.ai/api/v1/models \
  -H "Authorization: Bearer $FELO_API_KEY"

مدلی را انتخاب کنید که از endpoint شما پشتیبانی می‌کند و id بازگشتی را به‌عنوان model به‌کار ببرید. مدل‌های ویدئو و Decisions از endpointهای جداگانه استفاده می‌کنند.

ارسال درخواست Data API

curl https://openapi.felo.ai/v1/beta/tavily/search \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"What is Felo AI?","max_results":3}'

این مثال از جستجوی Tavily استفاده می‌کند. برای endpointهای دیگر، ارائه‌دهنده، مسیر و بدنه درخواست را جایگزین کنید.

FeloAPI CLI

Felo را از ترمینال راه‌اندازی کنید

Codex یا Claude Code را انتخاب کنید، کلید API خود را جای‌گذاری کنید و بگذارید CLI مدل‌ها، Felo Skills یا هر دو را پیکربندی کند.

Terminal

npx feloapi-cli setup

به Node.js 22+ نیاز دارد. عامل خود را جداگانه نصب کنید. به حساب npm نیازی نیست.

نصب و استفاده ساخت کلید API

مستندات را کاوش کنید

Felo APIs

APIهای آماده استفاده را پیکربندی کنید، از جمله Search، PPT، SuperAgent، LiveDoc، Web Fetch، X Search، Mindmap و بیشتر.

Felo Skills برای Agentهای AI پیکربندی Claude Code و Codex Chat API LLM API PPT Task API

شروع

قبل از فراخوانی APIها یک کلید بسازید و احراز هویت را بفهمید.

شروع FeloAPI CLI احراز هویت

راهنماها

لایه API مناسب را انتخاب کنید، مدل‌ها و مسیریابی را بفهمید و کارهای طولانی‌مدت را مدیریت کنید.

نمای کلی پلتفرم مدل‌ها و قیمت‌گذاری کانال‌ها و مسیریابی ارائه‌دهنده پروتکل‌ها و SDKها کارهای ناهمزمان

راه‌اندازی ابزارهای AI

Codex، Claude Code، DeepSeek Harness، OpenClaw، Cursor، Cline و دیگر کلاینت‌های Agent را پیکربندی کنید.

Codex Claude Code OpenCode OpenClaw Hermes Agent

پرسش‌های متداول

صورت‌حساب، اعتبار و عیب‌یابی مبتنی بر نشانه را بررسی کنید.

صورت‌حساب و اعتبار عیب‌یابی

5,000+ API شخص ثالث

فراتر از endpointهای خود Felo: فهرست‌های بک‌لینک، برآورد ترافیک، پست‌های شبکه‌های اجتماعی، داده‌های بازار و بیشتر، از ارائه‌دهندگان نام‌دار — همه با همان کلید قابل فراخوانی هستند.

مرور فهرست API

Core AI

Search-grounded chat and direct model calls through familiar protocol shapes.

POST/v2/chat

Chat API

Generate answers with query analysis and cited web resources.

GET/api/v1/models

Model discovery

List public model IDs available through Felo API Platform.

POST/api/v1/chat/completions

Chat Completions

Use an OpenAI-compatible chat endpoint.

POST/api/v1/messages

Messages

Use an Anthropic-compatible messages endpoint.

Generation Tasks

Async workflows for PPT, landing page, and mindmap generation.

GET/v2/ppt-themes

PPT themes

List available PPT themes with pagination and language filters.

POST/v2/ppts

Create PPT task

Start a PPT generation task and poll task status.

POST/v2/ppts/{ppt_business_id}/export

Export PPTX

Start an asynchronous PPTX export and retrieve a 30-minute download URL.

POST/v2/landing_page

Create landing page task

Generate landing page content asynchronously.

POST/v2/mindmap

Create mindmap

Generate a mindmap from a prompt and optional LiveDoc context.

Agents and Knowledge

Conversation streaming, LiveDoc knowledge bases, resources, retrieval, and routing.

POST/v2/conversations

Create conversation

Create a SuperAgent conversation and receive a stream key.

GET/v2/conversations/stream/{stream_key}

Consume SSE stream

Read real-time SuperAgent output with SSE.

POST/v2/livedocs

Create LiveDoc

Create a knowledge base for resources and retrieval.

POST/v2/livedocs/{short_id}/resources/retrieve

Retrieve resources

Run semantic retrieval over LiveDoc resources.

Search and Extraction

Utilities for web pages, YouTube transcripts, and X search workflows.

POST/v2/web/extract

Web Fetch API

Extract web content as HTML, text, or Markdown.

GET/v2/youtube/subtitling

YouTube Subtitling

Fetch subtitles with optional timestamps.

POST/v2/x/tweet/search

Search tweets

Search X posts by keyword and paging options.

POST/v2/x/user/search

Search users

Find X users and profile metadata.

شروع سریع

در چند دقیقه با Felo API Platform راه‌اندازی شوید:

ساخت حساب - یک حساب Felo رایگان بسازید
دریافت کلید API - کلید API خود را از صفحه API Keys بسازید
ارسال نخستین درخواست - Chat API را با یک فرمان ساده cURL امتحان کنید
ساخت برنامه - توانمندی‌های Felo را در برنامه خود ادغام کنید

مرور API

Chat API (v2)

Chat API به شما امکان می‌دهد تجربه‌های گفت‌وگویی مبتنی بر هوش مصنوعی و جستجوی وب بسازید. یک پرسش بفرستید و پاسخی تولیدشده توسط هوش مصنوعی بر پایه نتایج جستجوی وب در زمان واقعی دریافت کنید.

ویژگی‌های کلیدی:

یکپارچگی با جستجوی وب در زمان واقعی
پاسخ‌های جامع تولیدشده توسط هوش مصنوعی
استناد و ارجاع به منابع
تحلیل و بهینه‌سازی پرسش

بیشتر درباره Chat API بدانید →

PPT Task API (v2)

PPT Task API گردش‌کارهای ناهمگام تولید PPT را امکان‌پذیر می‌کند:

ساخت وظایف تولید PPT
استعلام وضعیت اجرای وظیفه
استعلام فراداده نتیجه تاریخی وظیفه (شامل error_message و live_doc_url در وضعیت‌های پایانی ناموفق)

بیشتر درباره PPT Task API بدانید →

SuperAgent API (v2)

SuperAgent API توانمندی گفت‌وگو مبتنی بر هوش مصنوعی را با خروجی جریانی در زمان واقعی و یکپارچگی LiveDoc فراهم می‌کند:

گفت‌وگو بسازید و یک stream_key برای مصرف SSE دریافت کنید
خروجی جریان SSE را در زمان واقعی مصرف کنید
در یک گفت‌وگوی موجود پرسش پیگیری بپرسید و یک stream_key تازه بگیرید
جزئیات گفت‌وگو را بر اساس thread_short_id استعلام کنید
LiveDocها و منابع آن‌ها را فهرست و بررسی کنید

بیشتر درباره SuperAgent API بدانید →

LiveDoc API (v2)

LiveDoc API عملیات کامل CRUD برای LiveDocها و منابع آن‌ها فراهم می‌کند:

ساخت و مدیریت LiveDocها (پایگاه‌های دانش)
بارگذاری فایل یا وارد کردن URL به‌عنوان منبع
انجام بازیابی معنایی روی یک LiveDoc

بیشتر درباره LiveDoc API بدانید →

X (Twitter) Search API (v2)

X Search API دسترسی به داده‌های X (توییتر پیشین) را فراهم می‌کند:

دریافت دسته‌ای نمایه‌های کاربران بر اساس نام کاربری
جستجوی توییت‌ها بر اساس کلیدواژه
دریافت خط زمانی توییت‌های یک کاربر
دریافت پاسخ‌ها به یک توییت مشخص

بیشتر درباره X Search API بدانید →

Web Extract API (v2)

Web Extract API محتوا را از هر URL با گزینه‌های خروجی انعطاف‌پذیر استخراج می‌کند:

قالب‌های خروجی متعدد: html، text، markdown
حالت‌های خزش سریع یا دقیق
پردازش خوانایی اختیاری، خلاصه پیوند/تصویر و هدف‌گیری با انتخابگر CSS

بیشتر درباره Web Extract API بدانید →

YouTube Subtitling API (v2)

YouTube Subtitling API داده زیرنویس ویدیوهای YouTube را دریافت می‌کند:

دریافت زیرنویس بر اساس کد ویدیو
تعیین زبان زیرنویس
گنجاندن اختیاری اطلاعات برچسب زمانی

بیشتر درباره YouTube Subtitling API بدانید →

LLM API

LLM API نقطه‌های پایانی فراخوانی مستقیم مدل را برای کلاینت‌های سازگار با OpenAI و سازگار با Anthropic ارائه می‌دهد:

POST /api/v1/chat/completions سازگار با OpenAI Chat Completions
POST /api/v1/messages سازگار با Anthropic Messages
POST /api/v1/responses سازگار با OpenAI Responses
راهنمای پیکربندی Claude Code

بیشتر درباره LLM API بدانید →

پیکربندی Claude Code →

پشتیبانی

به کمک نیاز دارید؟ ما اینجا هستیم:

مستندات - راهنماهای جامع و مرجع API ما را مرور کنید
GitHub Issues - اشکال‌ها را گزارش کنید یا درخواست ویژگی بدهید
پشتیبانی ایمیلی - با [email protected] تماس بگیرید