Felo API PlatformFelo API Platform

Felo پریزنٹیشن بنائیں

Provider: Felo · platform balance سے ادا شدہ

ایک presentation کو asynchronous طور پر generate کریں، پھر ایک PPTX file ایکسپورٹ کریں۔ generation اور export steps کو الگ رکھیں: create کیا گیا task ابھی مکمل file نہیں ہوتا۔

تمام examples، overview سے FELO_API_KEY استعمال کرتے ہیں۔ Calls platform balance استعمال کرتی ہیں، Felo Pro credits نہیں۔ Response examples صرف وضاحتی ہیں؛ live content اور optional fields مختلف ہو سکتے ہیں۔

1. پیشکش بنائیں

POST /api/v1/data/ppts

فیلڈقسملازمیمعنی
querystringہاںبنانے کی ہدایات، 1–25,000 حروف
stream_protocolstringنہیںطے شدہ message_center_v1; عموماً بدلا نہ جائے
ppt_configobjectنہیںاختیاری ترتیب؛ موجودہ نفاذ ai_theme_id پڑھتا ہے
livedoc_short_idstringنہیںموجودہ سیاق ID، 100 حروف تک؛ native API ملکیت اور معیاد ختم ہونے کی جانچ پاس ہونی چاہیے
resource_idsسٹرنگ ارےنہیں100 UUID وسائل IDs تک؛ اسی سیاق رسائی جانچ کے تابع

پہلی integration کے لیے، context اور configuration fields کو چھوڑ دیں۔ /v2 کے ذریعے بنایا گیا context یہاں خودکار طور پر دوبارہ استعمال کے لیے اہل نہیں ہوتا۔

curl -sS --request POST "https://openapi.felo.ai/api/v1/data/ppts" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Create a 5-slide introduction to retrieval augmented generation for software developers."}'

HTTP 200 root پر identifiers واپس کرتا ہے:

{
  "task_id":"example-task-id",
  "ppt_business_id":"example-ppt-id",
  "livedoc_short_id":"example-livedoc-id",
  "expires_at":"2026-11-13T00:00:00Z"
}

مزید identifiers جیسے resource_id، stream_key اور thread_short_id بھی موجود ہو سکتے ہیں۔ successful create response کا مطلب یہ ہے کہ task قبول کر لیا گیا، یہ نہیں کہ generation مکمل ہو گئی ہے۔ requested slide count صرف ایک instruction ہے؛ billing اصل generated page count استعمال کرتی ہے۔

TASK_ID="example-task-id"
PPT_ID="example-ppt-id"

SSE کے ساتھ بنانے کے واقعات پڑھیں

اگر creation ایک stream_key واپس کرے، تو اسی account سے تعلق رکھنے والی API Key کے ساتھ فوراً connect کریں۔ اگر کوئی stream key واپس نہ آئے، تو نیچے دی گئی status اور result queries استعمال کریں۔

curl -N 'https://openapi.felo.ai/api/v1/data/conversations/stream/YOUR_STREAM_KEY?format=structured' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: text/event-stream'
سوالی پیرامیٹرمعنی
formatraw (طے شدہ) content سٹرنگ کو جوں کا توں رکھتا ہے؛ structured درست JSON کو آبجیکٹ یا ارے میں ڈی کوڈ کرتا ہے
offsetدوبارہ جڑنے کے لیے اختیاری upstream دوبارہ شروع کرنے کی پوزیشن؛ اسے اپنی مقامی ایونٹ تعداد سے اخذ نہ کریں

ہر مکمل SSE event پڑھیں، اس کے outer JSON کو decode کریں، پھر content پر عمل کریں۔ ایک answer application event، data.text میں متن رکھتا ہے؛ finished stream میں generation کی تکمیل کا اشارہ دیتا ہے۔ upstream done، [DONE]، اور error signals کو بھی handle کریں۔ اگر completion signal کے بغیر connection بند ہو جائے، تو task status query کریں۔

SuperAgent SSE میں parsing rules اور client example استعمال کریں، اس section کے /api/v1/data/conversations/stream/{stream_key} URL کے ساتھ۔ stream ختم ہونے کے بعد task result پڑھیں؛ PPTX export بدستور الگ step ہے۔ یہ endpoint /api/v1/data/chat پر stream: true فعال نہیں کرتا۔

مدت، ملکیت اور بلنگ

  • Presentations creation کے سات دن بعد expire ہو جاتی ہیں۔ queries اور exports اس مدت میں توسیع نہیں کرتے۔ presentation expires_at اور signed download URL expires_at مختلف lifetimes کو بیان کرتے ہیں۔
  • صرف creating API account اپنی tasks اور presentations تک رسائی حاصل کر سکتا ہے۔ missing یا inaccessible resource، 404 واپس کر سکتی ہے؛ expired یا deleted resource، 410، یا cleanup کے بعد 404 واپس کر سکتی ہے۔
  • Generation کی بلنگ فی generated page (ppt.generate) ہوتی ہے۔ page pricing کے تحت، creation دس pages کی قیمت reserve کرتی ہے، پھر اصل successful output کے مطابق settlement ہوتی ہے اور غیر استعمال شدہ reservation release کر دی جاتی ہے۔ آپ کے account میں reservation کے لیے کافی available balance ہونا چاہیے چاہے prompt میں کم pages مانگے گئے ہوں۔
  • Export کی الگ request price (ppt.export) ہے۔ Status queries، result queries، export-status queries اور deletion کوئی نئی charge پیدا نہیں کرتے۔
  • timeout کے بعد، دوسری presentation بنانے کے بجائے محفوظ شدہ task query کریں۔ Billing and Errors دیکھیں۔

مدد چاہیے؟