Documentation Index
Fetch the complete documentation index at: https://docs-v1.agno.com/llms.txt
Use this file to discover all available pages before exploring further.
The FastAPI App is used to serve Agents or Teams using a FastAPI server with a rest api interface.
Example Usage
Create an agent, wrap it with FastAPIApp, and serve it:
from agno.agent import Agent
from agno.app.fastapi.app import FastAPIApp
from agno.models.openai import OpenAIChat
basic_agent = Agent(
name="Basic Agent",
agent_id="basic_agent",
model=OpenAIChat(id="gpt-4o"), # Ensure OPENAI_API_KEY is set
add_history_to_messages=True,
num_history_responses=3,
add_datetime_to_instructions=True,
markdown=True,
)
# Async router by default (use_async=True)
fastapi_app = FastAPIApp(
agents=[basic_agent],
name="Basic Agent",
app_id="basic_agent",
description="A basic agent that can answer questions and help with tasks.",
)
app = fastapi_app.get_app()
# For synchronous router:
# app = fastapi_app.get_app(use_async=False)
if __name__ == "__main__":
fastapi_app.serve(app="basic:app", port=8001, reload=True)
- Set
OPENAI_API_KEY environment variable.
- API at
http://localhost:8001, docs at http://localhost:8001/docs.
Send POST requests to http://localhost:8001/runs?agent_id=basic_agent:
curl -s -X POST "http://localhost:8001/runs?agent_id=basic_agent" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'message=Hello!' | jq -r .content
Core Components
FastAPIApp: Wraps Agno agents/teams for FastAPI.FastAPIApp.serve: Serves the FastAPI app using Uvicorn.
FastAPIApp uses helper functions for routing.
FastAPIApp Class
Main entry point for Agno FastAPI apps.
Initialization Parameters
| Parameter | Type | Default | Description |
|---|
agents | Optional[List[Agent]] | None | List of Agno Agent instances. |
teams | Optional[List[Team]] | None | List of Agno Team instances. |
workflows | Optional[List[Team]] | None | List of Agno Workflow instances. |
settings | Optional[APIAppSettings] | None | API configuration. Defaults if None. |
api_app | Optional[FastAPI] | None | Existing FastAPI app. New one created if None. |
router | Optional[APIRouter] | None | Existing APIRouter. New one created if None. |
app_id | Optional[str] | None | App identifier (autogenerated if not set). |
name | Optional[str] | None | Name for the App. |
description | Optional[str] | None | Description for the App. |
agent or team, not both.
Key Method
| Method | Parameters | Return Type | Description |
|---|
get_app | use_async: bool = True
prefix: str = "/v1" | FastAPI | Returns configured FastAPI app (async by default). Sets prefix, error handlers, CORS, docs. |
Endpoints
Endpoints are available at the specified prefix (default /v1).
1. POST /run
- Description: Interacts with the agent/team (uses
agent.run()/arun() or team.run()/arun()).
- Request Form Parameters:
| Parameter | Type | Default | Description |
|---|
message | str | ... | Input message (Required). |
stream | bool | True (sync), False (async default) | Stream response. |
monitor | bool | False | Enable monitoring. |
session_id | Optional[str] | None | Session ID for conversation continuity. |
user_id | Optional[str] | None | User ID. |
files | Optional[List[UploadFile]] | None | Files to upload. |
- Responses:
stream=True: StreamingResponse (text/event-stream) with JSON RunResponse/TeamRunResponse events.stream=False: JSON RunResponse/TeamRunResponse dictionary.
Parameters
| Parameter | Type | Default | Description |
|---|
app | Union[str, FastAPI] | N/A | FastAPI app instance or import string (Required). |
host | str | "localhost" | Host to bind. |
port | int | 7777 | Port to bind. |
reload | bool | False | Enable auto-reload for development. |
