Getting Started

Felo API Platform gives you one key for agent tools, model protocols, Search, Web Fetch, PPT, Mindmap, LiveDocs, X Search, YouTube Subtitling, Landing Page, and SuperAgent APIs. Start here, pick the tool you use, then follow that tool's dedicated setup guide.

Quick Start Flow

1. Get one Felo API Platform key, or buy a plan if you need more quota.
2. Choose your AI tool or platform from the table below.
3. Open the matching setup guide and paste in the Felo base URL and API key.
4. Run a small task in that tool to confirm the connection.
5. Add workflow APIs when your agent needs search, office output, web extraction, image workflows, LiveDocs, or SuperAgent.

Step 1: Get Your API Key

Felo API Platform uses one API key across direct API calls and supported AI tools.

1. Open the Felo API Platform API Keys page.
2. Sign in with your Felo account if prompted.
3. Enter a key name and click Create Key.
4. Copy the full key when it appears. It is only shown once.
5. Store the key securely and use it as FELO_API_KEY.

You can start with a free-to-try key. If your workflow needs higher usage, more model access, or team usage, choose a paid plan from your Felo account.

Set the key as an environment variable:

export FELO_API_KEY="YOUR_API_KEY"

Windows PowerShell:

$env:FELO_API_KEY="YOUR_API_KEY"

Step 2: Choose Your AI Tool

Click the tool you want to use. Each link opens a dedicated setup guide with the right base URL, environment variables, and verification step.

Step 3: Use the Right Base URL

Most tools ask for three values: API key, base URL, and model name. Choose the base URL based on the protocol that the tool supports.

If you are not sure which mode your client supports, start with the OpenAI-compatible base URL. Use the Anthropic-compatible base URL for Claude Code or clients that explicitly ask for an Anthropic Messages endpoint.

Step 4: Verify with a Direct API Call

If you only want to confirm that your key works, call the Chat API directly.

curl -X POST https://openapi.felo.ai/v2/chat \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Research the latest AI agent product trends"
  }'

A successful response includes an answer, query analysis, and web resources.

{
  "status": "ok",
  "data": {
    "id": "HabCj883yHLSXc8mWqu4Eq",
    "message_id": "18ea8517-5559-4f48-a355-1f8a79e73b71",
    "answer": "...",
    "query_analysis": {
      "queries": ["AI agent product trends"]
    },
    "resources": [
      {
        "link": "https://example.com/report",
        "title": "AI Agent Market Report",
        "snippet": "..."
      }
    ]
  }
}

Step 5: Add Workflow APIs

After your first tool or API call works, connect the APIs that match your scenario.

Direct API Examples

If you are building directly against the API instead of configuring an AI tool, start with one of these minimal calls.

Create a PPT Task

Use the PPT Task API when you want to generate a slide deck asynchronously. The response returns a task_id that you can poll.

curl -X POST https://openapi.felo.ai/v2/ppts \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Create a 5-slide strategy deck about AI agents for office productivity"
  }'

Example response:

{
  "status": "ok",
  "message": null,
  "data": {
    "task_id": "019cad6d-e874-55ef-d577-686344b5a7e9",
    "livedoc_short_id": "PvyKouzJirXjFdst4uKRK3",
    "ppt_business_id": "BfLPuQKmChk9SPmyQawxgr"
  }
}

Poll the task status:

curl -X GET https://openapi.felo.ai/v2/tasks/019cad6d-e874-55ef-d577-686344b5a7e9/status \
  -H "Authorization: Bearer $FELO_API_KEY"

Create a Landing Page Task

Use the Landing Page Task API when you want Felo to generate a landing page from a prompt.

curl -X POST https://openapi.felo.ai/v2/landing_page \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Generate a launch landing page for an AI research assistant"
  }'

Example response:

{
  "status": "ok",
  "message": null,
  "data": {
    "task_id": "019cad6d-e874-55ef-d577-686344b5a7e9",
    "thread_short_id": "9qiLTmT77fA3aVurrMHvRJ"
  }
}

Poll the same task status endpoint used by PPT tasks:

curl -X GET https://openapi.felo.ai/v2/tasks/019cad6d-e874-55ef-d577-686344b5a7e9/status \
  -H "Authorization: Bearer $FELO_API_KEY"

Python

import os
import requests

api_key = os.environ["FELO_API_KEY"]

response = requests.post(
    "https://openapi.felo.ai/v2/chat",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Content-Type": "application/json",
    },
    json={"query": "What are the latest AI agent product trends?"},
    timeout=60,
)

response.raise_for_status()
print(response.json()["data"]["answer"])

JavaScript (Node.js)

const response = await fetch("https://openapi.felo.ai/v2/chat", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.FELO_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "What are the latest AI agent product trends?",
  }),
});

if (!response.ok) {
  throw new Error(`Felo API request failed: ${response.status}`);
}

const result = await response.json();
console.log(result.data.answer);

Common Setup Issues

Next Steps

• Set up Codex
• Set up Claude Code
• Authentication Guide
• LLM API Reference
• Chat API Reference
• SuperAgent API Reference