# commentor API

> commentor の API の仕様と使い方。

commentor は HTML の文書にコメントを付けて共有するサービスです。API の全操作の要求項目・応答・エラーは、このドキュメントのサイトの https://commentor-docs.fsmarketing.workers.dev/openapi.json （OpenAPI 3.1）にあります。リファレンスの各ページの .md には項目が入りません。手順はガイドのページを読んでください。要求には `Authorization: Bearer <トークン>` を付けます。

## Docs

- [はじめに](/): commentor の API と CLI で文書を共有し、コメントを扱うための入口。
- [トークンと認証](/auth): 共有トークンと個人トークンの違い、要求の送り方、失敗したときの見方。
- [ログインと個人トークン](/login): CLI からブラウザのログインを使い、本人用の個人トークンを発行する手順。
- [CLI（cr）](/cr): 統合 CLI でログイン、文書、コメント、共有、個人トークンを操作する方法。
- [エラーと対処](/errors): よく返るエラーと、そのときにすること。

## ガイド

- [文書を上げる](/guides/upload): HTML の文書を上げ、本文を差し替え、版を追加する手順。
- [コメントを読む](/guides/read-comments): 文書のコメント・返信・解決の状態を読む手順。
- [エージェントがコメントを書く](/guides/agent-comments): 文書を読み、run を開始し、コメントを書いて、run を終えるまでの手順。
- [指摘を反映して版を上げる](/guides/apply-and-version): 未解決のコメントを本文に反映し、新しい版を上げて、コメントに返信して解決するまでの手順。
- [題名・タグ・共有先を変える](/guides/manage): 管理用トークンで、題名・タグ・アーカイブ・共有先を変え、文書を削除する手順。

## Reference

- [commentor API](/reference)

### Account

- [個人トークンの一覧を読む](/reference/account/list-personal-tokens)
- [個人トークンを取り消す](/reference/account/revoke-personal-token)
- [本人の情報を読む](/reference/account/get-me)

### Auth

- [CLI のログインコードを個人トークンに交換する](/reference/auth/exchange-cli-login-code)

### Comments

- [コメントに返信する](/reference/comments/reply-to-comment)
- [コメントの位置を付け替える](/reference/comments/update-comment-anchor)
- [コメントの本文を直す](/reference/comments/edit-comment)
- [コメントを書く](/reference/comments/create-comment)
- [コメントを解決する・再オープンする](/reference/comments/set-comment-status)
- [コメントを追加する](/reference/comments/add-human-comment)
- [仮のコメントを取り消す](/reference/comments/cancel-provisional-comment)
- [仮の返信を取り消す](/reference/comments/cancel-provisional-reply)
- [返信の本文を直す](/reference/comments/edit-thread-message)

### Import

- [文書を上げる](/reference/import/import-html)
- [本文を差し替える・版を追加する](/reference/import/update-html)

### Manage

- [オーナーを移譲する](/reference/manage/transfer-review-owner)
- [タグとアーカイブを変える](/reference/manage/update-review-meta)
- [共有先を変える](/reference/manage/update-review-access)
- [共有先を読む](/reference/manage/get-review-access)
- [文書を削除する](/reference/manage/delete-review)
- [題名を変える](/reference/manage/rename-review)

### Organization

- [社外メンバーを削除する](/reference/organization/remove-organization-member)
- [社外メンバーを登録する](/reference/organization/register-organization-member)
- [組織のメンバーを読む](/reference/organization/list-organization-members)
- [組織メンバーを変更する](/reference/organization/update-organization-member)
- [組織管理者を外す](/reference/organization/revoke-organization-admin)
- [組織管理者を読む](/reference/organization/list-organization-admins)
- [組織管理者を追加する](/reference/organization/grant-organization-admin)

### Projects

- [文書と案件の結び付きを外す](/reference/projects/unlink-project-document)
- [文書を案件に結び付ける](/reference/projects/link-project-document)
- [案件の一覧を読む](/reference/projects/list-projects)
- [案件の役割を付け外しする](/reference/projects/change-project-roles)
- [案件の役割を読む](/reference/projects/list-project-roles)

### Reviews

- [文書とコメントを読む](/reference/reviews/get-review)
- [文書の一覧を読む](/reference/reviews/list-reviews)
- [文書を JSON で作る](/reference/reviews/create-review)
- [版の HTML を読む](/reference/reviews/get-version-bundle)
- [見出しの区切りの一覧を読む](/reference/reviews/get-dom-context)

### Runs

- [run を終える](/reference/runs/finish-run)
- [run を開始する](/reference/runs/start-run)

### Search

- [コメントを横断して探す](/reference/search/search-comments)
- [文書を横断して探す](/reference/search/search-docs)

## Agent resources

- [llms-full.txt](/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [API catalog](/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](/agent-readability.json): Manifest of every agent-facing artifact on this site.