Felo API PlatformFelo API Platform

Docs

Build with Felo API Platform.

Start with authentication, make your first request, connect AI tools through the LLM API, then configure Harness APIs for search, office, content, extraction, and knowledge workflows.

Start

Create a key and understand authentication before calling APIs.

Getting StartedAuthentication

AI Tool Setup

Configure Codex, Claude Code, OpenClaw, Cursor, Cline, and other agent clients.

CodexClaude CodeOpenCodeOpenClawHermes Agent

LLM API

Call model endpoints through OpenAI-compatible and Anthropic-compatible protocols.

Claude Code and Codex ConfigurationLLM API

Configure Harness

Configure ready-to-use APIs including Search, PPT, SuperAgent, LiveDoc, Web Fetch, X Search, Mindmap, and more.

Felo Skills for AI AgentsChat APIPPT Task APILanding Page Task APISuperAgent API

Core AI

Search-grounded chat and direct model calls through familiar protocol shapes.

POST/v2/chat

Chat API

Generate answers with query analysis and cited web resources.

GET/api/v1/models

Model discovery

List public model IDs available through Felo API Platform.

POST/api/v1/chat/completions

Chat Completions

Use an OpenAI-compatible chat endpoint.

POST/api/v1/messages

Messages

Use an Anthropic-compatible messages endpoint.

Generation Tasks

Async workflows for PPT, landing page, and mindmap generation.

GET/v2/ppt-themes

PPT themes

List available PPT themes with pagination and language filters.

POST/v2/ppts

Create PPT task

Start a PPT generation task and poll task status.

POST/v2/landing_page

Create landing page task

Generate landing page content asynchronously.

POST/v2/mindmap

Create mindmap

Generate a mindmap from a prompt and optional LiveDoc context.

Agents and Knowledge

Conversation streaming, LiveDoc knowledge bases, resources, retrieval, and routing.

POST/v2/conversations

Create conversation

Create a SuperAgent conversation and receive a stream key.

GET/v2/conversations/stream/{stream_key}

Consume SSE stream

Read real-time SuperAgent output with SSE.

POST/v2/livedocs

Create LiveDoc

Create a knowledge base for resources and retrieval.

POST/v2/livedocs/{short_id}/resources/retrieve

Retrieve resources

Run semantic retrieval over LiveDoc resources.

Search and Extraction

Utilities for web pages, YouTube transcripts, and X search workflows.

POST/v2/web/extract

Web Fetch API

Extract web content as HTML, text, or Markdown.

GET/v2/youtube/subtitling

YouTube Subtitling

Fetch subtitles with optional timestamps.

POST/v2/x/tweet/search

Search tweets

Search X posts by keyword and paging options.

POST/v2/x/user/search

Search users

Find X users and profile metadata.

Quick Start

Get up and running with Felo API Platform in minutes:

  1. Create an Account - Sign up for a free Felo account
  2. Get Your API Key - Generate your API key from the API Keys page
  3. Make Your First Request - Try our Chat API with a simple cURL command
  4. Build Your Application - Integrate Felo's capabilities into your app

API Overview

Chat API (v2)

The Chat API enables you to build conversational experiences powered by AI and web search. Send a query and receive an AI-generated answer based on real-time web search results.

Key Features:

  • Real-time web search integration
  • AI-generated comprehensive answers
  • Source citations and references
  • Query analysis and optimization

Learn more about Chat API →

PPT Task API (v2)

The PPT Task API enables asynchronous PPT generation workflows:

  • Create PPT generation tasks
  • Query task running status
  • Query task historical result metadata (including error_message and live_doc_url on terminal failure statuses)

Learn more about PPT Task API →

SuperAgent API (v2)

The SuperAgent API provides AI-powered conversation capabilities with real-time streaming output and LiveDoc integration:

  • Create conversations and receive a stream_key for SSE consumption
  • Consume real-time SSE stream output
  • Ask follow-up questions in an existing conversation, get a new stream_key
  • Query conversation detail by thread_short_id
  • List and inspect LiveDocs and their resources

Learn more about SuperAgent API →

LiveDoc API (v2)

The LiveDoc API provides full CRUD operations for LiveDocs and their resources:

  • Create and manage LiveDocs (knowledge bases)
  • Upload files or import URLs as resources
  • Perform semantic retrieval over a LiveDoc

Learn more about LiveDoc API →

X (Twitter) Search API (v2)

The X Search API provides access to X (formerly Twitter) data:

  • Batch retrieve user profiles by username
  • Search tweets by keyword
  • Fetch a user's tweet timeline
  • Fetch replies to a specific tweet

Learn more about X Search API →

Web Extract API (v2)

The Web Extract API extracts content from any URL with flexible output options:

  • Multiple output formats: html, text, markdown
  • Fast or fine crawl modes
  • Optional readability processing, link/image summaries, and CSS selector targeting

Learn more about Web Extract API →

YouTube Subtitling API (v2)

The YouTube Subtitling API retrieves subtitle data for YouTube videos:

  • Fetch subtitles by video code
  • Specify subtitle language
  • Optionally include timestamp information

Learn more about YouTube Subtitling API →

LLM API

The LLM API exposes direct model calling endpoints for OpenAI-compatible and Anthropic-compatible clients:

  • OpenAI Chat Completions compatible POST /api/v1/chat/completions
  • Anthropic Messages compatible POST /api/v1/messages
  • OpenAI Responses compatible POST /api/v1/responses
  • Claude Code configuration guidance

Learn more about LLM API →

Configure Claude Code →

Support

Need help? We're here for you:

  • Documentation - Browse our comprehensive guides and API reference
  • GitHub Issues - Report bugs or request features
  • Email Support - Contact us at [email protected]

Stay Updated

Follow our changelog to stay informed about new features, improvements, and API updates.