APIの概要

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

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

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

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

kana api list
kana api execute <operation> --param key=value

kana api list は呼び出せるすべての操作を表示します。GET 以外の操作には --yes が必要です。kana api を参照してください。

https://app.kanaeru.ai/orc

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

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

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

{
  "statusCode": 401,
  "message": "Missing x-api-key header"
}

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

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

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