Felo API PlatformFelo API Platform

Felo APIs

Chat API

Přidejte konverzační vyhledávání AI s analýzou dotazů, webovými zdroji a citacemi.

POST/v2/chat

Ověřování

Bearer API key

Typ obsahu

application/json

Poznámky k limitům

Per API key and per user windows. Read X-RateLimit headers.

Chat API vám umožňuje integrovat konverzační vyhledávání poháněné AI do vašich aplikací. Odešlete dotaz v přirozeném jazyce a obdržíte inteligentní odpověď vygenerovanou z výsledků webového vyhledávání v reálném čase.

Limity rychlosti, chybové odpovědi a chování při opakování najdete v části Chyby, limity a opakování.

Přehled

Chat API provádí následující operace:

  1. Analyzuje a optimalizuje váš dotaz
  2. Prohledává web a hledá relevantní informace
  3. Řadí a filtruje výsledky vyhledávání
  4. Generuje komplexní odpověď AI na základě zdrojů
  5. Vrací odpověď spolu s citacemi zdrojů

Případy použití:

  • Konverzační AI asistenti
  • Nástroje pro výzkum a vyhledávání informací
  • Chatboti zákaznické podpory se znalostmi z webu
  • Vzdělávací aplikace
  • Nástroje pro tvorbu obsahu

Ověřování

Všechny požadavky na Chat API vyžadují ověření pomocí API klíče. Uveďte svůj API klíč v hlavičce Authorization:

Authorization: Bearer YOUR_API_KEY

Podrobnosti o získání a používání API klíče najdete v příručce k ověřování.

Použití s AI agenty

Nainstalujte kompletní balíček felo-ai, když chcete, aby agent používal Search a všechny ostatní dostupné Felo Skills. Instalátor dynamicky objevuje každý adresář balíčku obsahující SKILL.md, takže zahrnuje i budoucí Skills namísto pevné podmnožiny. Nainstalujte je do nativního adresáře pro svého agenta: Codex používá ~/.codex/skills, Claude Code používá ~/.claude/skills, OpenClaw používá ~/.agents/skills a Hermes Agent používá ~/.hermes/skills. Bezpečné propojení, API klíč a kroky ověření pro každou platformu najdete v příručce k ručnímu nastavení AI agenta.

Endpoint

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

Požadavek

Hlavičky

HlavičkaPovinnéPopis
AuthorizationAnoVáš API klíč ve formátu: Bearer YOUR_API_KEY
Content-TypeAnoMusí být application/json

Parametry těla požadavku

ParametrTypPovinnéPopisOmezení
querystringAnoOtázka nebo dotaz uživatele1–2000 znaků

Příklad požadavku

{
  "query": "What are the latest developments in quantum computing?"
}

Odpověď

Úspěšná odpověď (200 OK)

Když je požadavek úspěšný, API vrací odpověď JSON s následující strukturou:

{
  "status": "ok",
  "message": null,
  "data": {
    "id": "HabCj883yHLSXc8mWqu4Eq",
    "message_id": "18ea8517-5559-4f48-a355-1f8a79e73b71",
    "answer": "Recent developments in quantum computing include...",
    "query_analysis": {
      "queries": [
        "quantum computing latest developments 2025",
        "quantum computing breakthroughs"
      ]
    },
    "resources": [
      {
        "link": "https://example.com/quantum-news",
        "title": "Latest Quantum Computing Breakthroughs",
        "snippet": "Scientists have achieved a major milestone..."
      },
      {
        "link": "https://example.com/quantum-research",
        "title": "Quantum Computing Research 2025",
        "snippet": "New quantum algorithms show promise..."
      }
    ]
  }
}

Pole odpovědi

PoleTypPopis
statusstring | numberStav odpovědi: "ok" při úspěchu; chybové odpovědi používají stavový kód HTTP jako číslo
messagestring | nullDoplňující zpráva (null u úspěšných požadavků)
dataobjectData odpovědi (přítomna pouze tehdy, když je status "ok")
data.idstringJedinečný identifikátor této chatové relace
data.message_idstringJedinečný identifikátor této konkrétní zprávy
data.answerstringOdpověď vygenerovaná AI na dotaz
data.query_analysisobjectAnalýza dotazu uživatele
data.query_analysis.queriesstring[]Optimalizované vyhledávací dotazy odvozené ze vstupu uživatele
data.resourcesarraySeznam webových zdrojů použitých k vygenerování odpovědi
data.resources[].linkstringURL zdroje
data.resources[].titlestringNázev zdrojové stránky
data.resources[].snippetstringRelevantní výňatek ze zdroje

Chybová odpověď

Když dojde k chybě, API vrací sdílenou obálku chyby:

{
  "status": 401,
  "code": "UNAUTHORIZED",
  "message": "API Key is required",
  "request_id": "..."
}

Pole chybové odpovědi

PoleTypPopis
statusnumberStavový kód HTTP; úspěšné odpovědi používají "ok"
codestringKód chyby identifikující typ chyby
messagestringPopis chyby čitelný pro člověka
request_idstringJedinečný identifikátor tohoto požadavku (užitečný pro podporu)

Kódy chyb

HTTPKódVýznam
400Validační kód endpointuPole query chybí, je prázdné nebo příliš dlouhé; konkrétní problém najdete v poli message
401UNAUTHORIZEDAPI klíč chybí, je neplatný nebo zrušený
429RATE_LIMITEDByl překročen limit rychlosti
502CHAT_FAILEDInterní chyba služby
503SERVICE_UNAVAILABLESlužba je dočasně nedostupná

Sdílenou obálku, další kódy chyb a pravidla opakování najdete v části Chyby, limity a opakování.

Příklady

cURL

curl -X POST https://openapi.felo.ai/v2/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What are the benefits of renewable energy?"
  }'

Odpověď:

{
  "status": "ok",
  "message": null,
  "data": {
    "id": "HabCj883yHLSXc8mWqu4Eq",
    "message_id": "18ea8517-5559-4f48-a355-1f8a79e73b71",
    "answer": "Renewable energy offers numerous benefits including reduced greenhouse gas emissions, decreased air pollution, energy independence, job creation, and long-term cost savings. Solar, wind, and hydroelectric power are sustainable alternatives to fossil fuels that help combat climate change while providing reliable electricity.",
    "query_analysis": {
      "queries": [
        "renewable energy benefits",
        "advantages of renewable energy sources"
      ]
    },
    "resources": [
      {
        "link": "https://example.com/renewable-benefits",
        "title": "Top Benefits of Renewable Energy",
        "snippet": "Renewable energy sources provide clean, sustainable power..."
      }
    ]
  }
}

Python

import requests
import os

# Get API key from environment variable
api_key = os.environ.get('FELO_API_KEY')

url = 'https://openapi.felo.ai/v2/chat'
headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}
data = {
    'query': 'What are the benefits of renewable energy?'
}

try:
    response = requests.post(url, headers=headers, json=data)
    response.raise_for_status()  # Raise exception for HTTP errors

    result = response.json()

    if result['status'] == 'ok':
        print('Answer:', result['data']['answer'])
        print('\nSources:')
        for resource in result['data']['resources']:
            print(f"- {resource['title']}: {resource['link']}")
    else:
        print(f"Error: {result['code']} - {result['message']}")

except requests.exceptions.RequestException as e:
    print(f'Request failed: {e}')

JavaScript (Node.js)

const fetch = require('node-fetch');

const apiKey = process.env.FELO_API_KEY;
const url = 'https://openapi.felo.ai/v2/chat';

const headers = {
  'Authorization': `Bearer ${apiKey}`,
  'Content-Type': 'application/json'
};

const body = JSON.stringify({
  query: 'What are the benefits of renewable energy?'
});

fetch(url, { method: 'POST', headers, body })
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    if (data.status === 'ok') {
      console.log('Answer:', data.data.answer);
      console.log('\nSources:');
      data.data.resources.forEach(resource => {
        console.log(`- ${resource.title}: ${resource.link}`);
      });
    } else {
      console.error(`Error: ${data.code} - ${data.message}`);
    }
  })
  .catch(error => {
    console.error('Request failed:', error);
  });

JavaScript (Browser/Fetch API)

const apiKey = 'YOUR_API_KEY'; // In production, get this from your backend

fetch('https://openapi.felo.ai/v2/chat', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: 'What are the benefits of renewable energy?'
  })
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    if (data.status === 'ok') {
      console.log('Answer:', data.data.answer);

      // Display sources
      const sourcesList = data.data.resources.map(resource =>
        `<li><a href="${resource.link}">${resource.title}</a></li>`
      ).join('');

      document.getElementById('answer').innerHTML = data.data.answer;
      document.getElementById('sources').innerHTML = sourcesList;
    } else {
      console.error(`Error: ${data.code} - ${data.message}`);
    }
  })
  .catch(error => {
    console.error('Request failed:', error);
  });

Go

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
)

type ChatRequest struct {
    Query string `json:"query"`
}

type ChatResponse struct {
    Status  string `json:"status"`
    Message string `json:"message,omitempty"`
    Data    struct {
        ID            string `json:"id"`
        MessageID     string `json:"message_id"`
        Answer        string `json:"answer"`
        QueryAnalysis struct {
            Queries []string `json:"queries"`
        } `json:"query_analysis"`
        Resources []struct {
            Link    string `json:"link"`
            Title   string `json:"title"`
            Snippet string `json:"snippet"`
        } `json:"resources"`
    } `json:"data,omitempty"`
    Code      string `json:"code,omitempty"`
    RequestID string `json:"request_id,omitempty"`
}

func main() {
    apiKey := os.Getenv("FELO_API_KEY")
    url := "https://openapi.felo.ai/v2/chat"

    requestBody := ChatRequest{
        Query: "What are the benefits of renewable energy?",
    }

    jsonData, err := json.Marshal(requestBody)
    if err != nil {
        fmt.Printf("Error marshaling request: %v\n", err)
        return
    }

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    if err != nil {
        fmt.Printf("Error creating request: %v\n", err)
        return
    }

    req.Header.Set("Authorization", "Bearer "+apiKey)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Error making request: %v\n", err)
        return
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Printf("Error reading response: %v\n", err)
        return
    }

    var chatResp ChatResponse
    err = json.Unmarshal(body, &chatResp)
    if err != nil {
        fmt.Printf("Error unmarshaling response: %v\n", err)
        return
    }

    if chatResp.Status == "ok" {
        fmt.Println("Answer:", chatResp.Data.Answer)
        fmt.Println("\nSources:")
        for _, resource := range chatResp.Data.Resources {
            fmt.Printf("- %s: %s\n", resource.Title, resource.Link)
        }
    } else {
        fmt.Printf("Error: %s - %s\n", chatResp.Code, chatResp.Message)
    }
}

Limity rychlosti

Uživatelé s aktivním placeným předplatným Felo (včetně podnikových předplatných) jsou vyjmuti ze všech limitů rychlosti /v2/chat, a to při ověřování pomocí API klíče i OAuth. Vyňaté odpovědi neobsahují hlavičky X-RateLimit-*.

Uživatelé bez placeného předplatného podléhají limitům rychlosti ve třech dimenzích. Pokud stav předplatného nelze ověřit, tyto limity se stále uplatňují:

  • Na API klíč – omezuje požadavky provedené jedním API klíčem v okně 1 minuty.
  • Na uživatele (minuta) – omezuje souhrnné požadavky napříč všemi API klíči vlastněnými uživatelem v okně 1 minuty.
  • Na uživatele (hodina) – omezuje souhrnné požadavky napříč všemi API klíči vlastněnými uživatelem v okně 1 hodiny.

Překročení kterékoli dimenze vyvolá odpověď 429 Too Many Requests.

Přesné číselné limity se mohou v čase měnit. Vždy je čtěte z hlaviček odpovědi níže, nikoli ze snímků dokumentace.

Hlavičky odpovědi (odpovědi podléhající limitům rychlosti, včetně 429):

HlavičkaVýznam
X-RateLimit-LimitLimit nejužší dimenze, která je aktuálně v platnosti
X-RateLimit-RemainingMinimální zbývající kvóta napříč třemi dimenzemi
X-RateLimit-ResetUnixový časový údaj (sekundy), kdy se aktuální okno resetuje

U 429 navíc:

HlavičkaVýznam
Retry-AfterDoporučené zpoždění před opakováním (sekundy)

Příklad těla 429 (message odráží aktuálně nakonfigurované limity v okamžiku požadavku):

{
  "status": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests. Limit: <N>/min per API key, <M>/min per user, <H>/hour per user.",
  "request_id": "..."
}

Chování klienta: pokud je přítomna, čtěte X-RateLimit-Remaining a proaktivně zvyšujte odstup. Při 429 počkejte alespoň Retry-After sekund (nebo do X-RateLimit-Reset), než požadavek zopakujete. Nezadávejte hodnoty limitů natvrdo.

Kompletní zásady opakování a pokyny k rostoucímu odstupu najdete v části Chyby, limity a opakování. Pokud potřebujete vyšší limity rychlosti, kontaktujte [email protected].

Osvědčené postupy

1. Ošetřujte chyby elegantně

Vždy kontrolujte stav odpovědi a vhodně ošetřujte chyby:

if result['status'] == 'ok':
    # Process successful response
    answer = result['data']['answer']
else:
    # Handle error
    error_code = result['code']
    error_message = result['message']
    # Log error, show user-friendly message, etc.

2. Implementujte logiku opakování

U přechodných chyb (stavové kódy 5xx) implementujte exponenciální rostoucí odstup:

import time

max_retries = 3
retry_delay = 1  # seconds

for attempt in range(max_retries):
    response = requests.post(url, headers=headers, json=data)

    if response.status_code < 500:
        break  # Success or client error, don't retry

    if attempt < max_retries - 1:
        time.sleep(retry_delay * (2 ** attempt))  # Exponential backoff

3. Ukládejte odpovědi do mezipaměti

Zvažte ukládání odpovědí pro identické dotazy do mezipaměti, abyste snížili počet volání API a zlepšili dobu odezvy.

4. Ověřujte vstup

Před odesláním do API ověřte vstup uživatele:

  • Ujistěte se, že dotaz není prázdný
  • Zkontrolujte délku dotazu (1–2000 znaků)
  • Vyčistěte vstup, abyste zabránili útokům typu injection

5. Sledujte využití

Sledujte využití API, abyste zůstali v mezích limitů rychlosti a optimalizovali náklady:

  • Zaznamenávejte počty požadavků a doby odezvy
  • Sledujte míru chyb
  • Nastavte upozornění na neobvyklé vzory

Podpora

Potřebujete pomoc s Chat API?

Historie změn

v2.0.0 (aktuální)

  • První vydání Chat API
  • Podpora dotazů v přirozeném jazyce
  • Integrace webového vyhledávání v reálném čase
  • Odpovědi generované AI s citacemi zdrojů