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

# API Overview

> HTTP API for building on top of Arden.

## Base URL

```
http://localhost:6877
```

Configure with `ARDEN_HOST` and `ARDEN_PORT`.

## Authentication

All endpoints except `/health` require a Bearer token:

```bash theme={null}
curl http://localhost:6877/session \
  -H "Authorization: Bearer YOUR_API_KEY"
```

See [Authentication](/api-reference/authentication) for details.

## Response format

All endpoints return JSON. The event stream (`GET /chat/events/{session_id}`) uses Server-Sent Events (SSE).

## Endpoints

| Group                                     | Endpoints                                                                                      | Description                                       |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| [Chat](/api-reference/chat)               | `GET /chat/events/{session_id}`, `POST /chat/message`, `POST /chat/background`, `POST /cancel` | SSE stream, messaging, background mode            |
| [Sessions](/api-reference/sessions)       | `/session*`, `/sessions*`                                                                      | Session management                                |
| [Areas](/api-reference/areas)             | `/areas*`, `/asks*`                                                                            | Areas, outcomes, standing agents, and requests    |
| [Facts and Wiki](/api-reference/memory)   | `/admin/facts*`, `/admin/wiki/pages*`                                                          | Fact reads and pins; versioned managed wiki pages |
| [Automations](/api-reference/automations) | `/automations*`, `/loops*`                                                                     | Scheduled tasks and in-chat loops                 |
| [Config](/api-reference/config)           | `/config*`, `/models*`, `/providers*`, `/services*`, `/directives`                             | Configuration, providers, models                  |
| Health                                    | `GET /health`                                                                                  | Server status (public)                            |

## Health check

```bash theme={null}
curl http://localhost:6877/health
```

```json theme={null}
{
  "status": "ok",
  "version": "1.0.0rc3",
  "has_providers": true,
  "outbox": {
    "worker_running": true,
    "pending": 0,
    "ready": 0,
    "running": 0,
    "dead": 0
  },
  "config_version": 1,
  "config_loaded_at": "2026-07-30T12:00:00+00:00"
}
```

Pass a Bearer token to add an `auth` result:

```json theme={null}
{
  "auth": true
}
```
