commentor API

commentor は、HTML の文書にコメントを付けて共有するサービスです。 この API を使うと、AI エージェントやプログラムから、文書を上げ、読み、コメントを書き、返信し、解決し、題名や共有先を変えられます。

共有トークンまたは本人用の個人トークンを Authorization: Bearer <トークン> で送ります。各操作の Authorization の欄に、使える方式と必要な範囲を書いています。

Reviews

文書の一覧・中身・コメントを読む。

• GET
  文書とコメントを読む/api/reviews/{reviewId}
• GET
  見出しの区切りの一覧を読む/api/reviews/{reviewId}/dom-context
• GET
  版の HTML を読む/api/reviews/{reviewId}/versions/{versionId}/bundle
• GET
  文書の一覧を読む/api/reviews
• POST
  文書を JSON で作る/api/reviews

Runs

エージェントの作業のまとまり（run）を開始し、終える。

• POST
  run を開始する/api/reviews/{reviewId}/ai-review-runs
• PATCH
  run を終える/api/reviews/{reviewId}/ai-review-runs/{runId}

Comments

コメントを書き、返信し、解決し、直す。

• POST
  コメントを書く/api/reviews/{reviewId}/ai-review-runs/{runId}/comments
• POST
  コメントに返信する/api/reviews/{reviewId}/comments/{commentId}/thread
• POST
  コメントを解決する・再オープンする/api/reviews/{reviewId}/comments/{commentId}/status-events
• DELETE
  仮のコメントを取り消す/api/reviews/{reviewId}/comments/{commentId}
• PATCH
  コメントの本文を直す/api/reviews/{reviewId}/comments/{commentId}
• DELETE
  仮の返信を取り消す/api/reviews/{reviewId}/comments/{commentId}/thread/{messageId}
• PATCH
  返信の本文を直す/api/reviews/{reviewId}/comments/{commentId}/thread/{messageId}
• POST
  コメントを追加する/api/reviews/{reviewId}/comments
• PATCH
  コメントの位置を付け替える/api/reviews/{reviewId}/comments/{commentId}/anchor

Import

HTML の文書を上げる。本文を差し替える。版を追加する。

• POST
  文書を上げる/api/reviews/import-html
• POST
  本文を差し替える・版を追加する/api/reviews/{reviewId}/import-html

Manage

題名・タグ・アーカイブ・共有先を変える。文書を削除する。

• DELETE
  文書を削除する/api/reviews/{reviewId}
• PATCH
  題名を変える/api/reviews/{reviewId}/title
• PATCH
  タグとアーカイブを変える/api/reviews/{reviewId}/meta
• GET
  共有先を読む/api/reviews/{reviewId}/access
• PATCH
  共有先を変える/api/reviews/{reviewId}/access
• PUT
  オーナーを移譲する/api/reviews/{reviewId}/owner

Search

自分が見られる文書の中から、コメントと文書を語で探す。

• GET
  コメントを横断して探す/api/search/comments
• GET
  文書を横断して探す/api/search/docs

Account

本人の情報と、本人用の個人トークンを扱う。

• GET
  本人の情報を読む/api/me
• GET
  個人トークンの一覧を読む/api/me/tokens
• DELETE
  個人トークンを取り消す/api/me/tokens/{tokenId}

Auth

CLI のログインで使うコード交換。

• POST
  CLI のログインコードを個人トークンに交換する/api/auth/cli/token

Projects

案件の一覧・役割・文書との結び付きを扱う。

• GET
  案件の一覧を読む/api/projects
• GET
  案件の役割を読む/api/projects/{code}/roles
• PATCH
  案件の役割を付け外しする/api/projects/{code}/roles
• PUT
  文書を案件に結び付ける/api/projects/{code}/docs/{reviewId}
• DELETE
  文書と案件の結び付きを外す/api/projects/{code}/docs/{reviewId}

Organization

組織のメンバーと管理者を扱う。

• GET
  組織のメンバーを読む/api/org/members
• POST
  社外メンバーを登録する/api/org/members
• DELETE
  社外メンバーを削除する/api/org/members
• PATCH
  組織メンバーを変更する/api/org/members
• GET
  組織管理者を読む/api/org/admins
• PUT
  組織管理者を追加する/api/org/admins
• DELETE
  組織管理者を外す/api/org/admins