# Felo API سیٹ اپ

تلاش، ویب مواد، X ڈیٹا اور پریزنٹیشنز کے لیے Data API میں Felo endpoints سیٹ اپ کریں، platform balance استعمال کرتے ہوئے۔

Felo، [Data API](https://openapi.felo.ai/ur/docs/data-api) میں ایک provider ہے، جو ویب تلاش، ویب مطالعہ، X ڈیٹا، تلاش پر مبنی جوابات اور پریزنٹیشنز فراہم کرتا ہے۔ ہر Felo endpoint کو متعلقہ Data API category میں دیگر providers کے ساتھ تلاش کریں۔

یہ endpoints **platform balance** اور `/api/v1/data` prefix استعمال کرتے ہیں۔ یہ گائیڈ authentication، آپ کی پہلی request اور billing rules کہاں ملیں گے، اس کی وضاحت کرتی ہے۔

Felo Pro credits استعمال کرنے کے لیے، [existing Felo APIs](https://openapi.felo.ai/ur/docs/api-reference/felo-apis.md) دیکھیں۔ Platform balance اور Pro credits الگ ہیں۔

## اپنی پہلی درخواست کریں

1. [Console → API Keys](https://openapi.felo.ai/console/api-keys) میں ایک key بنائیں۔
2. [Console → Billing](https://openapi.felo.ai/console/billing) میں اپنا **platform balance** چیک کریں یا اس میں رقم شامل کریں۔
3. key کو اپنے server پر یا اپنے local shell میں سیٹ کریں:

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

`Authorization: Bearer $FELO_API_KEY` بھیجیں۔ `X-API-Key` بھی قبول کیا جاتا ہے؛ authentication کا ایک طریقہ منتخب کریں۔ JSON requests کے لیے `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` array واپس کرتا ہے جس میں page titles، links اور snippets شامل ہوتے ہیں، ساتھ ہی `total` بھی۔ یہ conversational answer تیار نہیں کرتا؛ اس کے لیے [Chat](https://openapi.felo.ai/ur/docs/data-api/guides/felo-chat.md) استعمال کریں۔

## APIز دریافت کریں

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

ان guides میں **14 core operations** موجود ہیں۔ اگر PPT creation ایک `stream_key` واپس کرے، تو [PPT guide](https://openapi.felo.ai/ur/docs/data-api/guides/felo-ppt.md#sse) یہ بھی بتاتی ہے کہ SSE کے ساتھ generation events کیسے پڑھیں۔ Status اور result queries، export-status queries اور deletion نئی charge پیدا نہیں کرتے۔

## موجودہ انضمام کو منتقل کرنے سے پہلے

جس endpoint کو آپ call کرتے ہیں، اسی کے لیے مخصوص guide استعمال کریں۔ `/v2` کو `/api/v1/data` سے بدل دینا مکمل migration نہیں ہے:

- Web Read `/web/read` استعمال کرتا ہے، اور ہر request میں صرف ایک output format دیتا ہے۔
- Chat `status: "ok"` واپس کرتا ہے؛ یہ صرف non-streaming JSON کو support کرتا ہے۔
- PPT results میں **POST** `/tasks/{task_id}/historical` استعمال ہوتا ہے۔
- PPT creation JSON root پر identifiers واپس کرتی ہے۔ `task_id` اور `ppt_business_id` دونوں محفوظ کریں۔
- Generated PPTs سات دن بعد expire ہو جاتے ہیں۔ expiry سے پہلے اپنی file export اور save کر لیں۔

یہاں ہر `/v2` workflow کے لیے native OpenAPI equivalent documented نہیں ہے، جیسے LiveDoc CRUD، Mindmap یا SuperAgent۔ ان کے لیے ان کی [Felo APIs guides](https://openapi.felo.ai/ur/docs/api-reference/felo-apis.md) اور Pro-credit billing استعمال کرتے رہیں۔

## معاہدہ اور موجودہ قیمتیں

- [Published OpenAPI schema](https://openapi.felo.ai/api/v1/data/openapi.json) — field definitions اور response schemas۔
- [OpenAPI YAML schema](https://openapi.felo.ai/api/v1/data/openapi.yaml) — ان tools کے لیے جو YAML قبول کرتے ہیں۔
- [Current prices](https://openapi.felo.ai/api/v1/data/prices) — operation IDs، billing units اور current rates۔

یہ resources public ہیں اور key کے بغیر پڑھے جا سکتے ہیں۔ automatic retries شامل کرنے سے پہلے [Billing and Errors](https://openapi.felo.ai/ur/docs/data-api/guides/felo-billing.md) دیکھیں۔
