Installation

Requirements

Python 3.12 or higher
An API key from at least one LLM provider

Quick Install

pip install definable

uv pip install definable

poetry add definable

Full Setup

Create a virtual environment

python3 -m venv .venv
source .venv/bin/activate

python -m venv .venv
.venv\Scripts\activate

uv venv --python 3.12
source .venv/bin/activate

Install Definable

pip install definable

uv pip install definable

poetry add definable

Set your API key

export OPENAI_API_KEY=sk-***

setx OPENAI_API_KEY sk-***

Verify

from definable.agent import Agent

agent = Agent(model="gpt-4o")
output = agent.run("Hello!")
print(output.content)

Optional Dependencies

Install extras for specific features:

Feature	Install command
Discord interface	`pip install 'definable[discord]'`
All messaging interfaces	`pip install 'definable[interfaces]'`
File readers (PDF, DOCX, XLSX)	`pip install 'definable[readers]'`
HTTP server (FastAPI + Uvicorn)	`pip install 'definable[serve]'`
Cron scheduling	`pip install 'definable[cron]'`
JWT authentication	`pip install 'definable[jwt]'`
Memory with Mem0	`pip install 'definable[mem0-memory]'`
Deep research	`pip install 'definable[research]'`
CLI / TUI interface	`pip install 'definable[cli]'`
Full runtime (all of the above)	`pip install 'definable[runtime]'`

Core Dependencies

These are installed automatically with pip install definable:

Package	Purpose
`openai`	OpenAI API client (also used by OpenAI-compatible providers)
`pydantic`	Data validation and structured outputs
`httpx`	Async HTTP client
`tiktoken`	Token counting
`rich`	Formatted logging and terminal output
`docstring-parser`	Tool description extraction from docstrings
`aiosqlite`	SQLite async driver for memory and identity storage

Environment Variables

Set API keys for the providers you use. Only the keys you need are required.

# LLM Providers
export OPENAI_API_KEY="sk-..."
export DEEPSEEK_API_KEY="sk-..."
export MOONSHOT_API_KEY="sk-..."
export XAI_API_KEY="xai-..."
export ANTHROPIC_API_KEY="sk-ant-..."

# Embedding Providers
export VOYAGE_API_KEY="pa-..."

# Reranking Providers
export COHERE_API_KEY="..."

You can also pass API keys directly when creating model instances:

from definable.model.openai import OpenAIChat
model = OpenAIChat(id="gpt-4o", api_key="sk-...")

Get Started

Basics

Capabilities

Advanced

Requirements

Quick Install

Full Setup

Optional Dependencies

Core Dependencies

Environment Variables

Next Steps

Your First Agent

Models

​Requirements

​Quick Install

​Full Setup

​Optional Dependencies

​Core Dependencies

​Environment Variables

​Next Steps

Your First Agent

Models

Requirements

Quick Install

Full Setup

Optional Dependencies

Core Dependencies

Environment Variables

Next Steps