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

# Introduction

> The API for Production-Grade Agents

Omnara is an open source platform for running managed agents. It handles execution and state while you choose the models, tools, machines, and how users interact with each agent.

## Use cases

Omnara can be used to build agents for internal use cases or external use cases, such as:

* Internal slack bots
* Code review agents
* Agents integrated in a product dashboard

Omnara exposes a web interface, CLI, and REST API to enable these use cases.

## Build an agent

An agent starts as a small YAML config:

```yaml theme={null}
instruction: |
  You are an engineering assistant. Use your machine to run
  commands. Ask a question when a task is not clear.
model:
  provider_config: omnara-openrouter
  name: anthropic/claude-fable-5
tools:
  run_command: {}
  web_search: {}
  ask_question: {}
machine_sources:
  - machine_pool_name: default-pool
```

You can create and launch the agent in two ways:

* **Dashboard** — click **New agent** in your project in the dashboard.
* **Programmatically** - Omnara provides an **API**, **Typescript SDK**, and **CLI** to interact with Omnara

The [quickstart](/quickstart) provides a more detailed guide to setting up your first agent.

## Core concepts

1. An **organization** owns shared resources for your team: **projects**, **secrets**, **model providers**, and **machines**.
2. **Projects** contains agents. **Grants** decide which shared resources the project can use.
3. An **agent** is one durable conversation with its config, tool calls, and history. **Profiles** provide reusable agent configurations.
4. You send **inputs**, stream **events**, and resolve **interactions** in an agent.

The [concepts](/concepts) page gives a short overview of this model.

## Start here

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Write a config, create the grants, and launch an agent with the dashboard, the API, or the CLI
  </Card>

  <Card title="Concepts" icon="sitemap" href="/concepts">
    The object model, the agent loop, and access control
  </Card>
</CardGroup>
