はじめに

commentor の API と CLI で文書を共有し、コメントを扱うための入口。

commentor は、HTML の文書にコメントを付けて共有するサービスです。API と CLI を使うと、文書を作成し、コメントを読み書きし、題名・共有先・版をプログラムから操作できます。

社外のアカウントによる利用は準備中です。公開サイトの例は、組織内の利用を前提にしています。

最初に読むページ

1. ログインと個人トークン：CLI のログイン、範囲、保存、取り消し。
2. トークンと認証：API の認証方式、要求の形、失敗したときの見方。
3. CLI（cr）：文書、コメント、共有を操作するコマンド。
4. API リファレンス：操作ごとの項目、応答、エラー。
5. エラーと対処：よく返るエラーと対処方法。

できること

API の定義を読む

操作ごとの要求項目・応答・エラーは、サイトの /openapi.json（OpenAPI 3.1）にまとまっています。AI エージェントへ渡す場合は /llms.txt または /llms-full.txt を使えます。

各ページの URL に .md を付けると、説明を Markdown として取得できます。認証方式や個人トークンの範囲は、操作の security と トークンと認証を合わせて確認してください。