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

# What is orchagent?

> Deploy your AI agent. Your team can use it.

orchagent is an **AI agent deployment platform**. Build agents in Python, JavaScript, or plain English — deploy them to secure cloud sandboxes — and give your team a URL to run them via CLI, API, or web UI.

## How It Works

### For Developers (Building & Deploying)

```
1. Create agent: orch init my-agent
2. Define behavior (prompt + schema, code, or LLM loop)
3. Publish via CLI: orch publish
4. Agent is live — callable via CLI, API, or web UI
5. Team members run it from their workspace
6. See usage, run history, and logs in dashboard
```

### For Teams (Running Agents)

```
1. Get access to your team's workspace
2. Run agents: orch run team/agent-name
3. Or open the web UI — fill a form, click Run
4. Results displayed, logged, and tracked
```

## The Four Types

orchagent has four canonical types:

| Type         | What it does                                | Example                                    |
| ------------ | ------------------------------------------- | ------------------------------------------ |
| **`prompt`** | Single LLM call with your prompt + schema   | Sentiment analyzer, summarizer, translator |
| **`tool`**   | Your Python/JS code runs in a sandbox       | Security scanner, PDF parser, Discord bot  |
| **`agent`**  | LLM tool-use loop with custom tools         | Test fixer, code reviewer, research agent  |
| **`skill`**  | Passive knowledge (markdown) — not runnable | Coding standards, security rules           |

**Simple rule:**

* Want a single LLM answer? Use `type: "prompt"` (`orch run`)
* Want your code to execute? Use `type: "tool"` (`orch run`)
* Want the LLM to iterate with tools? Use `type: "agent"` (`orch run`)
* Want to share knowledge? Use `type: "skill"` (`orch skill install`)
* Want to **DELEGATE** to sub-agents? Export agents (`orch install`)

Executable types (prompt, tool, agent) are:

* **On-demand or always-on** (`run_mode`) — each call is independent, or [deploy as a service](/using-agents/services)
* **Specific** - one task, done well
* **Callable** - simple API or CLI call; optionally callable by other agents

Skills use the industry-standard Agent Skills format (adopted by Anthropic, Google, Microsoft, OpenAI, Cursor) and can be installed locally or composed with agents.

## Key Features

| Feature                                          | Description                                                      |
| ------------------------------------------------ | ---------------------------------------------------------------- |
| **Secure sandboxes**                             | Agents run in isolated E2B sandboxes. No infra to manage.        |
| **CLI & API**                                    | Deploy and run agents from terminal or via HTTP API              |
| **[orch-hq desktop app](/orch-hq)**              | Visual command centre with terminal, canvas, messages, and tasks |
| **[Agent messages](/using-agents/messages)**     | Agents send you briefings, alerts, and notifications             |
| **[Agent tasks](/using-agents/tasks)**           | Agents create tasks with due dates, priorities, and project tags |
| **[Integrations](/using-agents/integrations)**   | Connect Sentry, Slack, and more — agents use the credentials     |
| **Web Run UI**                                   | Non-developers run agents via a web form                         |
| **Team workspaces**                              | Organize agents by team, control access                          |
| **Run history**                                  | Every execution is logged with inputs, outputs, duration         |
| **[Scheduled runs](/using-agents/scheduling)**   | Run agents on a cron schedule or webhook trigger                 |
| **[Always-on services](/using-agents/services)** | Deploy agents as persistent services (Discord bots, workers)     |
| **BYOK model**                                   | Bring your own LLM API keys                                      |
| **Secrets vault**                                | Store API keys securely in your workspace                        |

## BYOK: Bring Your Own Key

orchagent uses a **Bring Your Own Key** model. Developers provide their own LLM API keys (OpenAI, Anthropic, Gemini).

**Why BYOK:**

* Authors don't pay for others' usage
* No middleman markup on LLM costs
* Direct billing with your LLM provider

<Note>
  API keys are separate from subscriptions (Claude Pro/Max, ChatGPT Plus). You'll need to set up API billing at [console.anthropic.com](https://console.anthropic.com) or [platform.openai.com](https://platform.openai.com).
</Note>

## Next Steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Deploy your first agent in minutes
  </Card>

  <Card title="API Reference" icon="code" href="/using-agents/api-reference">
    Authentication, endpoints, errors
  </Card>

  <Card title="CLI Commands" icon="terminal" href="/using-agents/cli-commands">
    orch login, run, publish
  </Card>

  <Card title="Agent Types" icon="hammer" href="/building-agents/agent-types">
    The four types — prompt, tool, agent, skill
  </Card>

  <Card title="orch-hq" icon="desktop" href="/orch-hq">
    Desktop command centre
  </Card>

  <Card title="Scheduling" icon="clock" href="/using-agents/scheduling">
    Cron schedules and webhooks
  </Card>
</CardGroup>