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

# API introduction

> The Kanaeru HTTP API: service health and automation triggers.

Kanaeru's HTTP API is small on purpose. Most programmatic work, like browsing visions, outcomes, and tasks and driving delivery, goes through the [Kana CLI](/cli/overview) or the [Kanaeru app in Codex and Claude](/mcp/connect).

<Note>
  This is the API of the Kanaeru product. The Kanaeru AI website has its own separate public API, for its services, case studies, blog posts, and contact and waitlist requests. See [www.kanaeru.ai/developers](https://www.kanaeru.ai/developers).
</Note>

## What about the API the web app uses?

The web app talks to a much larger internal API. It isn't public, and it changes without notice, so it isn't documented here. When you need something the CLI doesn't have a command for, `kana api` reaches the same operations with your own sign-in:

```bash theme={null}
kana api list
kana api execute <operation> --param key=value
```

`kana api list` prints every operation it can call. Anything other than a `GET` needs `--yes`. See [`kana api`](/cli/reference#kana-api).

## Base URL

```
https://app.kanaeru.ai/orc
```

## Authentication

| Endpoint | Authentication |
| - | - |
| `GET /orc/health` | None |
| `POST /orc/api/automation-triggers/{slug}` | The automation's API key in the `x-api-key` header |

Each automation with an **API** trigger gets its own key and slug. The key is shown only once, when you create the automation, so save it then. See [Automations](/guides/automations).

## Errors

Every error is JSON, never HTML:

```json theme={null}
{
  "statusCode": 401,
  "message": "Missing x-api-key header"
}
```

`statusCode` and `message` are always present.

## Machine-readable resources

| Resource | Contents |
| - | - |
| [`/openapi.json`](https://app.kanaeru.ai/openapi.json) | The OpenAPI 3.1 specification of the two endpoints above. |
| [`/llms.txt`](https://app.kanaeru.ai/llms.txt) | A short overview of Kanaeru for AI agents, with links to these docs |

Kanaeru's public pages also return Markdown when you request them with an `Accept: text/markdown` header.


## Related topics

- [Runtimes](/machines/runtimes.md)
- [Command reference](/cli/reference.md)
- [Automations](/guides/automations.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.