# sideagent

> sideagent embeds a chat agent in your app. It turns an OpenAPI spec into a secure agent endpoint and a React chat UI, and calls your API as the signed-in user. Available as an open-source TypeScript library (MIT) and as the hosted sideagent Cloud.

Each page is also available as Markdown at the same URL with `.md`. The whole documentation in one file: https://sideagent.dev/llms-full.txt

## Get started

- [Overview](https://sideagent.dev/docs/index.md): What sideagent is and the two ways to run it: the open-source library or sideagent Cloud.
- [Quickstart](https://sideagent.dev/docs/quickstart.md): Install sideagent, mount the agent on one route and render the chat in React.

## Library

- [Server](https://sideagent.dev/docs/server.md): createAgent options, adapters for Hono, Next.js and Express, and the doctor check.
- [Operations and allowlist](https://sideagent.dev/docs/operations.md): Which API operations the model can call, and the x-agent hints you can add to your spec.
- [User authentication](https://sideagent.dev/docs/auth.md): How getAuth identifies the signed-in user and forwards their credentials to your API.
- [Approvals](https://sideagent.dev/docs/approvals.md): How calls that change data pause for the user, and how approval tokens are bound to the exact arguments.
- [Knowledge](https://sideagent.dev/docs/knowledge.md): Give the agent documents it can search, from Markdown or public URLs, with a vector store.

## Chat UI

- [Chat UI](https://sideagent.dev/docs/chat-ui.md): The AgentChat and AgentProvider React components, the docked sidebar and result views.
- [Chat history](https://sideagent.dev/docs/history.md): Persistent threads with a checkpointer and a threadStore, and the History button in the chat.
- [Theming](https://sideagent.dev/docs/theming.md): Match the chat to your design system with CSS variables and light or dark themes.

## Reference

- [Wire protocol](https://sideagent.dev/docs/protocol.md): The request bodies and server-sent events the agent endpoint speaks.
- [Security model](https://sideagent.dev/docs/security.md): Default deny, user credentials, approvals, pinned host, limits, origins and redaction.

## Cloud

- [sideagent Cloud](https://sideagent.dev/docs/cloud.md): The hosted version: configure an agent in a dashboard and embed it with a publishable key.