# Persediaan API Felo

Sediakan titik akhir Felo dalam Data API untuk carian, kandungan web, data X dan persembahan, menggunakan baki platform.

Felo ialah satu penyedia dalam [Data API](https://openapi.felo.ai/ms/docs/data-api), menawarkan carian web, bacaan web, data X, jawapan berasaskan carian dan persembahan. Cari setiap titik akhir Felo bersama penyedia lain dalam kategori Data API yang berkaitan.

Titik akhir ini menggunakan **baki platform** dan awalan `/api/v1/data`. Panduan ini menerangkan pengesahan, permintaan pertama anda dan tempat untuk mencari peraturan pengebilan.

Untuk menggunakan kredit Felo Pro, lihat [API Felo sedia ada](https://openapi.felo.ai/ms/docs/api-reference/felo-apis.md). Baki platform dan kredit Pro adalah berasingan.

## Buat permintaan pertama anda

1. Cipta kunci dalam [Console → API Keys](https://openapi.felo.ai/console/api-keys).
2. Semak atau tambah nilai **baki platform** anda di [Console → Billing](https://openapi.felo.ai/console/billing).
3. Tetapkan kunci pada pelayan anda atau dalam shell tempatan anda:

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

Hantar `Authorization: Bearer $FELO_API_KEY`. `X-API-Key` juga diterima; pilih satu kaedah pengesahan. Permintaan JSON memerlukan `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 memulangkan tatasusunan `resources` dengan tajuk halaman, pautan dan petikan, serta `total`. Ia tidak menjana jawapan perbualan; gunakan [Sembang](https://openapi.felo.ai/ms/docs/data-api/guides/felo-chat.md) untuk itu.

## Terokai API

| Panduan | Operasi | Apa yang anda terima | Unit pengebilan |
|---|---|---|---|
| [Carian Web](https://openapi.felo.ai/ms/docs/data-api/guides/felo-web-search.md) | Cari web | Tajuk halaman, pautan dan petikan | Permintaan |
| [Baca Web](https://openapi.felo.ai/ms/docs/data-api/guides/felo-web-read.md) | Baca URL | Markdown, teks, HTML atau tangkapan skrin | Permintaan |
| [Data X](https://openapi.felo.ai/ms/docs/data-api/guides/felo-x-data.md) | Profil, carian pengguna, catatan pengguna, carian catatan, balasan | Pengguna dan catatan berstruktur, dengan paginasi jika disokong | Hasil dipulangkan |
| [Sembang Berasaskan Carian](https://openapi.felo.ai/ms/docs/data-api/guides/felo-chat.md) | Jawab soalan | Jawapan dan sumber web | Permintaan |
| [PPT](https://openapi.felo.ai/ms/docs/data-api/guides/felo-ppt.md) | Cipta, status, hasil, eksport, status eksport, padam | Tugas penjanaan dan PPTX yang boleh dimuat turun | Halaman dijana; eksport dibilkan secara berasingan |
| [Pengebilan dan Ralat](https://openapi.felo.ai/ms/docs/data-api/guides/felo-billing.md) | Panduan integrasi yang dikongsi | Harga, pengendalian baki dan peraturan percubaan semula | — |

Terdapat **14 operasi teras** merentas panduan ini. Jika penciptaan PPT memulangkan `stream_key`, [panduan PPT](https://openapi.felo.ai/ms/docs/data-api/guides/felo-ppt.md#baca-peristiwa-penjanaan-dengan-sse) juga menerangkan cara membaca peristiwa penjanaan dengan SSE. Pertanyaan status dan hasil, pertanyaan status eksport dan pemadaman tidak mencipta caj baharu.

## Sebelum memindahkan integrasi sedia ada

Gunakan panduan untuk titik akhir tepat yang anda panggil. Menggantikan `/v2` dengan `/api/v1/data` bukan migrasi lengkap:

- Baca Web menggunakan `/web/read`, dengan satu format output bagi setiap permintaan.
- Sembang memulangkan `status: "ok"`; ia hanya menyokong JSON tanpa penstriman.
- Hasil PPT menggunakan **POST** `/tasks/{task_id}/historical`.
- Penciptaan PPT memulangkan pengecam pada akar JSON. Simpan kedua-dua `task_id` dan `ppt_business_id`.
- PPT yang dijana tamat tempoh selepas tujuh hari. Eksport dan simpan fail anda sebelum tamat tempoh.

Tiada padanan OpenAPI asli yang didokumenkan di sini untuk setiap aliran kerja `/v2`, seperti CRUD LiveDoc, Mindmap atau SuperAgent. Terus gunakan [panduan API Felo](https://openapi.felo.ai/ms/docs/api-reference/felo-apis.md) dan pengebilan kredit Pro.

## Kontrak dan harga semasa

- [Skema OpenAPI yang diterbitkan](https://openapi.felo.ai/api/v1/data/openapi.json) — definisi medan dan skema respons.
- [Skema YAML OpenAPI](https://openapi.felo.ai/api/v1/data/openapi.yaml) — untuk alat yang menerima YAML.
- [Harga semasa](https://openapi.felo.ai/api/v1/data/prices) — ID operasi, unit pengebilan dan kadar semasa.

Sumber ini awam dan boleh dibaca tanpa kunci. Lihat [Pengebilan dan Ralat](https://openapi.felo.ai/ms/docs/data-api/guides/felo-billing.md) sebelum menambah percubaan semula automatik.
