> ## 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の概要

> KanaeruのHTTP API。サービスのヘルスチェックとオートメーションのトリガーです。

KanaeruのHTTP APIは、意図して小さく保っています。ビジョン、アウトカム、タスクの閲覧やデリバリーの操作など、プログラムからの作業のほとんどは [Kana CLI](/ja/cli/overview) または [CodexとClaudeのKanaeruアプリ](/ja/mcp/connect) を通して行います。

<Note>
  これはKanaeruプロダクトのAPIです。Kanaeru AIのWebサイトには、サービス、導入事例、ブログ記事、お問い合わせやウェイトリスト登録のための、別の公開APIがあります。[www.kanaeru.ai/developers](https://www.kanaeru.ai/developers) を参照してください。
</Note>

## Webアプリが使っているAPIは？

Webアプリは、はるかに大きな内部APIと通信しています。これは公開APIではなく、予告なく変更されるため、ここでは説明しません。CLIに専用のコマンドがない操作が必要な場合は、`kana api` を使うと、ご自身のサインインで同じ操作を呼び出せます。

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

`kana api list` は呼び出せるすべての操作を表示します。`GET` 以外の操作には `--yes` が必要です。[`kana api`](/ja/cli/reference#kana-api) を参照してください。

## ベースURL

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

## 認証

| エンドポイント | 認証 |
| - | - |
| `GET /orc/health` | なし |
| `POST /orc/api/automation-triggers/{slug}` | `x-api-key` ヘッダーに、そのオートメーションのAPIキー |

**API** トリガーを持つオートメーションには、それぞれ専用のキーとslugが発行されます。キーはオートメーションを作成したときに一度だけ表示されるので、その場で保存してください。[オートメーション](/ja/guides/automations) を参照してください。

## エラー

エラーはすべてJSONで返り、HTMLになることはありません。

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

`statusCode` と `message` は常に含まれます。

## 機械可読なリソース

| リソース | 内容 |
| - | - |
| [`/openapi.json`](https://app.kanaeru.ai/openapi.json) | 上記2つのエンドポイントのOpenAPI 3.1仕様 |
| [`/llms.txt`](https://app.kanaeru.ai/llms.txt) | AIエージェント向けのKanaeruの短い概要と、このドキュメントへのリンク |

Kanaeruの公開ページは、`Accept: text/markdown` ヘッダーを付けてリクエストするとMarkdownを返します。


## Related topics

- [Kanaeruの概要](/ja/index.md)
- [他のツールとの比較](/ja/concepts/comparison.md)
- [設定とプロフィール](/ja/guides/settings.md)


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