# راه‌اندازی Felo API

پایان‌نقاط Felo را در Data API برای جستجو، محتوای وب، داده‌های X و ارائه‌ها با استفاده از موجودی پلتفرم راه‌اندازی کنید.

Felo یکی از ارائه‌دهندگان در [Data API](https://openapi.felo.ai/fa/docs/data-api) است و جستجوی وب، خواندن وب، داده‌های X، پاسخ‌های مبتنی بر جستجو و ارائه‌ها را ارائه می‌دهد. هر پایان‌نقطه Felo را در کنار سایر ارائه‌دهندگان در دسته‌بندی مربوطه در Data API پیدا کنید.

این پایان‌نقطه‌ها از **موجودی پلتفرم** و پیشوند `/api/v1/data` استفاده می‌کنند. این راهنما احراز هویت، اولین درخواست شما و محل یافتن قوانین صورتحساب را توضیح می‌دهد.

برای استفاده از اعتبارات Felo Pro، به [APIهای موجود Felo](https://openapi.felo.ai/fa/docs/api-reference/felo-apis.md) مراجعه کنید. موجودی پلتفرم و اعتبارات Pro جدا هستند.

## اولین درخواست خود را انجام دهید

1. یک کلید در [Console → API Keys](https://openapi.felo.ai/console/api-keys) ایجاد کنید.
2. **موجودی پلتفرم** خود را در [Console → Billing](https://openapi.felo.ai/console/billing) بررسی یا شارژ کنید.
3. کلید را روی سرور خود یا در پوسته محلی‌تان تنظیم کنید:

```bash
export FELO_API_KEY="YOUR_API_KEY"
```

`Authorization: Bearer $FELO_API_KEY` را ارسال کنید. `X-API-Key` نیز پذیرفته می‌شود؛ یکی از روش‌های احراز هویت را انتخاب کنید. درخواست‌های JSON به `Content-Type: application/json` نیاز دارند.

```bash
curl -sS --request POST "https://openapi.felo.ai/api/v1/data/web/search" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"What is retrieval augmented generation?","count":3}'
```

HTTP 200 یک آرایه `resources` شامل عنوان‌های صفحه، پیوندها و گزیده‌ها، به‌همراه `total` را برمی‌گرداند. این کار یک پاسخ محاوره‌ای تولید نمی‌کند؛ برای آن از [Chat](https://openapi.felo.ai/fa/docs/data-api/guides/felo-chat.md) استفاده کنید.

## APIها را بررسی کنید

| راهنما | عملیات | آنچه دریافت می‌کنید | واحد صورتحساب |
|---|---|---|---|
| [جستجوی وب](https://openapi.felo.ai/fa/docs/data-api/guides/felo-web-search.md) | جستجوی وب | عنوان‌های صفحه، پیوندها و گزیده‌ها | درخواست |
| [خواندن وب](https://openapi.felo.ai/fa/docs/data-api/guides/felo-web-read.md) | خواندن یک URL | Markdown، متن، HTML یا تصویر صفحه | درخواست |
| [داده‌های X](https://openapi.felo.ai/fa/docs/data-api/guides/felo-x-data.md) | پروفایل‌ها، جستجوی کاربر، پست‌های کاربر، جستجوی پست، پاسخ‌ها | کاربران و پست‌های ساخت‌یافته، با صفحه‌بندی در صورت پشتیبانی | نتیجه بازگردانده‌شده |
| [گفت‌وگوی مبتنی بر جستجو](https://openapi.felo.ai/fa/docs/data-api/guides/felo-chat.md) | پاسخ به یک پرسش | پاسخ و منابع وب | درخواست |
| [PPT](https://openapi.felo.ai/fa/docs/data-api/guides/felo-ppt.md) | ایجاد، وضعیت، نتایج، خروجی، وضعیت خروجی، حذف | وظیفه تولید و PPTX قابل دانلود | صفحه تولیدشده؛ خروجی جداگانه صورتحساب می‌شود |
| [صورتحساب و خطاها](https://openapi.felo.ai/fa/docs/data-api/guides/felo-billing.md) | راهنمای یکپارچه‌سازی مشترک | قیمت‌ها، مدیریت موجودی و قواعد تلاش مجدد | — |

در این راهنماها در مجموع **14 عملیات اصلی** وجود دارد. اگر ایجاد PPT یک `stream_key` برگرداند، [راهنمای PPT](https://openapi.felo.ai/fa/docs/data-api/guides/felo-ppt.md#sse) همچنین توضیح می‌دهد که چگونه رویدادهای تولید را با SSE بخوانید. پرس‌وجوهای وضعیت و نتیجه، پرس‌وجوهای وضعیت خروجی و حذف، هزینه جدیدی ایجاد نمی‌کنند.

## پیش از انتقال یک یکپارچه‌سازی موجود

از راهنمای دقیق همان پایانی که فراخوانی می‌کنید استفاده کنید. جایگزینی `/v2` با `/api/v1/data` یک مهاجرت کامل نیست:

- Web Read از `/web/read` استفاده می‌کند و در هر درخواست فقط یک قالب خروجی دارد.
- Chat مقدار `status: "ok"` برمی‌گرداند؛ فقط JSON غیرجریانی را پشتیبانی می‌کند.
- نتایج PPT از **POST** `/tasks/{task_id}/historical` استفاده می‌کنند.
- ایجاد PPT شناسه‌ها را در ریشه JSON برمی‌گرداند. هر دو `task_id` و `ppt_business_id` را ذخیره کنید.
- PPTهای تولیدشده پس از هفت روز منقضی می‌شوند. فایل خود را پیش از انقضا خروجی بگیرید و ذخیره کنید.

برای هر گردش‌کار `/v2`، مانند CRUD LiveDoc، Mindmap یا SuperAgent، معادل بومی OpenAPI که در اینجا مستند شده باشد وجود ندارد. همچنان از [راهنماهای APIهای Felo](https://openapi.felo.ai/fa/docs/api-reference/felo-apis.md) و صورتحساب اعتبارات Pro استفاده کنید.

## قرارداد و قیمت‌های فعلی

- [اسکیما OpenAPI منتشرشده](https://openapi.felo.ai/api/v1/data/openapi.json) — تعریف فیلدها و اسکیماهای پاسخ.
- [اسکیما YAML OpenAPI](https://openapi.felo.ai/api/v1/data/openapi.yaml) — برای ابزارهایی که YAML را می‌پذیرند.
- [قیمت‌های فعلی](https://openapi.felo.ai/api/v1/data/prices) — شناسه‌های عملیات، واحدهای صورتحساب و نرخ‌های فعلی.

این منابع عمومی هستند و بدون کلید قابل خواندن‌اند. پیش از افزودن تلاش‌های مجدد خودکار، به [صورتحساب و خطاها](https://openapi.felo.ai/fa/docs/data-api/guides/felo-billing.md) مراجعه کنید.