> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upsonic.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# What is Upsonic

> Python framework for building autonomous and traditional AI agents, with tools, memory, RAG, multi-agent teams, and production deployment.

<Frame>
  <img src="https://mintcdn.com/upsonic/Wd1aNFxhmgwsV1ax/images/upsonic_hero.png?fit=max&auto=format&n=Wd1aNFxhmgwsV1ax&q=85&s=394f5eda9c9e14a13c751b000e6a5d64" alt="Upsonic" width="1894" height="1532" data-path="images/upsonic_hero.png" />
</Frame>

# Upsonic Framework

Upsonic is a Python framework for building **autonomous agents** like OpenClaw and Claude Cowork, as well as traditional single-task agents and multi-agent teams. One unified API and pipeline covers every primitive you need, including agents, tools, memory, knowledge bases, teams, and deployment.

### Install

```bash theme={null}
uv pip install upsonic
# pip install upsonic
```

### Configure API Keys

Put your provider keys in a `.env` file. Upsonic supports 30+ providers, including OpenAI, Anthropic, Google, Bedrock, Azure, Ollama, vLLM, Groq, and OpenRouter.

<CodeGroup>
  ```shellscript OpenAI theme={null}
  OPENAI_API_KEY=sk-***
  ```

  ```shellscript Anthropic theme={null}
  ANTHROPIC_API_KEY=sk-***
  ```

  ```shellscript Ollama theme={null}
  OLLAMA_BASE_URL="http://localhost:11434/v1/"
  ```
</CodeGroup>

See the full list in [LLM Support](/concepts/llm-support/llm-overview).

<br />

# Two ways to build

Upsonic gives you two agent primitives depending on the problem shape.

<CardGroup cols={2}>
  <Card title="Autonomous Agent" icon="robot" href="/concepts/autonomous-agent/overview">
    For open-ended, multi-step work. The agent plans, executes shell and filesystem operations, and iterates inside a sandboxed `workspace` that blocks path traversal and dangerous commands.
  </Card>

  <Card title="Traditional Agent" icon="user-robot" href="/concepts/agents/overview">
    For structured, tool-driven tasks with a defined input/output contract. Bring your own tools, response schemas, and run the agent over a `Task`.
  </Card>
</CardGroup>

### Autonomous Agent

```python theme={null}
from upsonic import AutonomousAgent, Task

agent = AutonomousAgent(
    model="anthropic/claude-sonnet-4-5",
    workspace="/path/to/logs"
)

task = Task("Analyze server logs and detect anomaly patterns")

agent.print_do(task)
```

All file and shell operations are restricted to `workspace`. For isolated cloud execution, plug in an [E2B sandbox](/concepts/autonomous-agent/overview).

### Traditional Agent

```python theme={null}
from upsonic import Agent, Task
from upsonic.tools import tool

@tool
def sum_tool(a: float, b: float) -> float:
    """Add two numbers together."""
    return a + b

agent = Agent(model="anthropic/claude-sonnet-4-5", name="Calculator")
task = Task(description="Calculate 15 + 27", tools=[sum_tool])

agent.print_do(task)
```

<br />

# Core building blocks

<CardGroup cols={2}>
  <Card title="Prebuilt Autonomous Agents" icon="sparkles" href="/concepts/prebuilt-autonomous-agents/overview">
    Ready-to-run autonomous agents contributed by the community. Install and go.
  </Card>

  <Card title="Tools" icon="wrench" href="/concepts/tools/overview">
    Function tools with `@tool`, full MCP support, and ready-to-use integrations (Tavily, Firecrawl, E2B, YFinance, and more).
  </Card>

  <Card title="Memory" icon="brain" href="/concepts/memory/overview">
    Conversation, focus, and summary memory with pluggable backends: SQLite, Postgres, Redis, Mongo, and Mem0.
  </Card>

  <Card title="Knowledge Base (RAG)" icon="book-open" href="/concepts/knowledgebase/overview">
    End-to-end RAG: document loaders, text splitters, 7+ embedding providers, and vector stores (Qdrant, Pinecone, Chroma, pgvector, Weaviate).
  </Card>

  <Card title="Teams" icon="people-group" href="/concepts/team/overview">
    Coordinate multiple agents with Sequential, Coordinate, or Route modes.
  </Card>

  <Card title="Skills" icon="graduation-cap" href="/concepts/skills/overview">
    Package reusable agent capabilities and load them from local paths, URLs, or GitHub.
  </Card>

  <Card title="OCR" icon="scanner-image" href="/concepts/ocr/overview">
    Unified OCR interface across EasyOCR, Tesseract, PaddleOCR, DeepSeek, and more.
  </Card>

  <Card title="HITL" icon="user-check" href="/concepts/hitl/overview">
    Human-in-the-loop for confirmations, user input, and durable execution pauses.
  </Card>

  <Card title="Tracing" icon="chart-line" href="/concepts/tracing/overview">
    First-class tracing with Langfuse and PromptLayer.
  </Card>

  <Card title="Safety Engine" icon="shield-check" href="/concepts/safety-engine/overview">
    Optional guardrails with prebuilt privacy, financial, security, and content policies.
  </Card>
</CardGroup>

<br />

# Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/get-started/quickstart">
    Run your first agent in under five minutes.
  </Card>

  <Card title="Framework 101" icon="forward-step" href="/guides/2-create-an-agent">
    Seven short guides covering tasks, agents, tools, MCP, memory, and teams.
  </Card>

  <Card title="Examples" icon="code" href="/examples/overview/introduction">
    Real-world examples: DevOps bots, document analyzers, research agents, sales workflows.
  </Card>

  <Card title="IDE Integration" icon="plug" href="/get-started/ide-integration">
    Add `https://docs.upsonic.ai/llms-full.txt` to Cursor, VSCode, or Windsurf.
  </Card>
</CardGroup>

<br />

# Community

* **[Discord](https://discord.gg/pmYDMSQHqY)**: Chat with the team and other developers.
* **[GitHub](https://github.com/Upsonic/Upsonic)**: Source, issues, and discussions.
* **[Changelog](/changelog)**: What shipped in each release.
