Felo APIs

Landing Page Task API

صفحه‌های فرود را به‌صورت ناهمزمان تولید کنید و تاریخچه کارها را بررسی کنید.

POST/v2/landing_page

احراز هویت

Bearer API key

نوع محتوا

application/json or multipart/form-data

یادداشت نرخ

ممکن است محدودیت‌های مخصوص endpoint اعمال شود.

PPT Task API LiveDoc API

Landing Page Task API توانمندی تولید ناهمگام صفحه فرود را فراهم می‌کند. نخست وظیفه‌ای می‌سازید، سپس از APIهای موجود پیگیری وضعیت وظیفه برای استعلام پیشرفت و نتایج دوباره استفاده می‌کنید.

احراز هویت

همه درخواست‌ها به یک کلید API در سرآیند Authorization نیاز دارند:

Authorization: Bearer YOUR_API_KEY

استفاده با عامل‌های هوش مصنوعی

بسته کامل felo-ai را نصب کنید تا یک عامل بتواند صفحه فرود بسازد و از هر Felo Skill در دسترس دیگر استفاده کند. نصب‌کننده به‌صورت پویا هر پوشه بسته شامل SKILL.md را کشف می‌کند، به‌جای تکیه بر فهرست ثابت. همه Skillهای کشف‌شده را در ~/.codex/skills مربوط به Codex، ~/.claude/skills مربوط به Claude Code، ~/.agents/skills مربوط به OpenClaw یا ~/.hermes/skills مربوط به Hermes Agent نصب کنید. برای گام‌های کلید API و بررسی مخصوص هر پلتفرم راهنمای راه‌اندازی دستی عامل هوش مصنوعی را بخوانید.

ساخت وظیفه صفحه فرود

Endpoint

POST https://openapi.felo.ai/v2/landing_page

سرآیندهای درخواست

سرآیند	الزامی	توضیح
`Authorization`	بله	کلید API شما در قالب `Bearer YOUR_API_KEY`
`Content-Type`	بله	`application/json` یا `multipart/form-data`

بدنه درخواست

پارامتر	نوع	الزامی	توضیح
`query`	string	بله	اعلان (prompt) درخواست تولید صفحه فرود
`stream_protocol`	string	خیر	پروتکل جریان. پیش‌فرض: `message_center_v1`
`livedoc_short_id`	string	خیر	شناسه کوتاه LiveDoc موجود برای استفاده به‌عنوان زمینه
`resource_ids`	آرایه‌ای از رشته‌ها	خیر	شناسه منابع LiveDoc برای استفاده به‌عنوان زمینه

نمونه

curl -X POST 'https://openapi.felo.ai/v2/landing_page' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "Generate a landing page for Felo Search"
  }'

ساخت با فایل

از multipart/form-data استفاده کنید تا یک فایل را همراه درخواست وظیفه Landing Page بارگذاری کنید. فایل نخست به‌عنوان منبع LiveDoc بارگذاری می‌شود، سپس شناسه منبع آن به وظیفه Landing Page داده می‌شود.

curl -X POST 'https://openapi.felo.ai/v2/landing_page' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F 'query=Generate a landing page from this product brief' \
  -F '[email protected]'

بخش‌های multipart اختیاری:

پارامتر	نوع	الزامی	توضیح
`stream_protocol`	string	خیر	پروتکل جریان. پیش‌فرض: `message_center_v1`
`livedoc_short_id`	string	خیر	شناسه کوتاه LiveDoc موجود. اگر حذف شود، LiveDoc تازه ساخته می‌شود

پاسخ موفق (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "task_id": "019cad6d-e874-55ef-d577-686344b5a7e9"
  }
}

فیلدهای پاسخ

فیلد	نوع	توضیح
`task_id`	string	شناسه وظیفه ناهمگام برای پیگیری‌های بعدی

پیگیری وضعیت وظیفه

وظایف Landing Page از همان APIهای پیگیری وضعیت وظیفه‌ای استفاده می‌کنند که PPT taskها به کار می‌برند.

Endpoint

GET https://openapi.felo.ai/v2/tasks/{task_id}/status

نمونه

curl -X GET 'https://openapi.felo.ai/v2/tasks/019cad6d-e874-55ef-d577-686344b5a7e9/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

استعلام اطلاعات تاریخی وظیفه

Endpoint

GET https://openapi.felo.ai/v2/tasks/{task_id}/historical

نمونه

curl -X GET 'https://openapi.felo.ai/v2/tasks/019cad6d-e874-55ef-d577-686344b5a7e9/historical' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

نمونه پاسخ تکمیل‌شده AI_PAGE

{
  "status": "ok",
  "message": null,
  "data": {
    "task_id": "019d7a4d-6ab5-a96d-0f98-43ca434ab621",
    "task_status": "COMPLETED",
    "ppt_biz_id": "9qiLTmT77fA3aVurrMHvRJ",
    "ppt_url": "https://felo.ai/slides/9qiLTmT77fA3aVurrMHvRJ",
    "ai_page_html": "https://felo.ai/ai-page/9qiLTmT77fA3aVurrMHvRJ"
  }
}

برای نمونه‌های مشترک پاسخ پیگیری وضعیت و معنای وضعیت‌ها به PPT Task API مراجعه کنید.

کدهای خطا

کد	وضعیت HTTP	توضیح
`UNAUTHORIZED`	401	کلید API نامعتبر یا لغوشده است
`LANDING_PAGE_TASK_CREATE_FAILED`	502	ساخت وظیفه صفحه فرود شکست خورد
`INSUFFICIENT_CREDITS`	402	اعتبار کافی در دسترس نیست