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

# Deploy Agent

> Deploy an agent to Orpheus

## Request

```http theme={null}
POST /v1/deploy
Content-Type: application/octet-stream

[agent tarball]
```

The tarball should contain:

```
agent-name/
  agent.yaml
  agent.py (or index.js)
  requirements.txt (optional)
```

## Create Tarball

```bash theme={null}
cd my-agent
tar -czvf ../my-agent.tar.gz .
```

## cURL Example

```bash theme={null}
curl -X POST http://localhost:7777/v1/deploy \
  -H "Content-Type: application/octet-stream" \
  --data-binary @my-agent.tar.gz
```

## Response

**Success (200):**

```json theme={null}
{
  "agent": "my-agent",
  "status": "deployed",
  "workers": 1
}
```

**Error (400):**

```json theme={null}
{
  "error": "agent.yaml not found"
}
```

## CLI Equivalent

```bash theme={null}
orpheus deploy ./my-agent
```

The CLI handles tarball creation automatically.

<Card title="Next: Run API" icon="play" href="/api-reference/run">
  Execute agents via API →
</Card>