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

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

Version 2026-10-02

Base URL: `https://comment-review.fsmarketing.workers.dev`

## Reviews

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

- [`GET /api/reviews/{reviewId}`](/reference/reviews/get-review) — 文書とコメントを読む.
- [`GET /api/reviews/{reviewId}/dom-context`](/reference/reviews/get-dom-context) — 見出しの区切りの一覧を読む.
- [`GET /api/reviews/{reviewId}/versions/{versionId}/bundle`](/reference/reviews/get-version-bundle) — 版の HTML を読む.
- [`GET /api/reviews`](/reference/reviews/list-reviews) — 文書の一覧を読む.
- [`POST /api/reviews`](/reference/reviews/create-review) — 文書を JSON で作る.

## Runs

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

- [`POST /api/reviews/{reviewId}/ai-review-runs`](/reference/runs/start-run) — run を開始する.
- [`PATCH /api/reviews/{reviewId}/ai-review-runs/{runId}`](/reference/runs/finish-run) — run を終える.

## Comments

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

- [`POST /api/reviews/{reviewId}/ai-review-runs/{runId}/comments`](/reference/comments/create-comment) — コメントを書く.
- [`POST /api/reviews/{reviewId}/comments/{commentId}/thread`](/reference/comments/reply-to-comment) — コメントに返信する.
- [`POST /api/reviews/{reviewId}/comments/{commentId}/status-events`](/reference/comments/set-comment-status) — コメントを解決する・再オープンする.
- [`DELETE /api/reviews/{reviewId}/comments/{commentId}`](/reference/comments/cancel-provisional-comment) — 仮のコメントを取り消す.
- [`PATCH /api/reviews/{reviewId}/comments/{commentId}`](/reference/comments/edit-comment) — コメントの本文を直す.
- [`DELETE /api/reviews/{reviewId}/comments/{commentId}/thread/{messageId}`](/reference/comments/cancel-provisional-reply) — 仮の返信を取り消す.
- [`PATCH /api/reviews/{reviewId}/comments/{commentId}/thread/{messageId}`](/reference/comments/edit-thread-message) — 返信の本文を直す.
- [`POST /api/reviews/{reviewId}/comments`](/reference/comments/add-human-comment) — コメントを追加する.
- [`PATCH /api/reviews/{reviewId}/comments/{commentId}/anchor`](/reference/comments/update-comment-anchor) — コメントの位置を付け替える.

## Import

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

- [`POST /api/reviews/import-html`](/reference/import/import-html) — 文書を上げる.
- [`POST /api/reviews/{reviewId}/import-html`](/reference/import/update-html) — 本文を差し替える・版を追加する.

## Manage

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

- [`DELETE /api/reviews/{reviewId}`](/reference/manage/delete-review) — 文書を削除する.
- [`PATCH /api/reviews/{reviewId}/title`](/reference/manage/rename-review) — 題名を変える.
- [`PATCH /api/reviews/{reviewId}/meta`](/reference/manage/update-review-meta) — タグとアーカイブを変える.
- [`GET /api/reviews/{reviewId}/access`](/reference/manage/get-review-access) — 共有先を読む.
- [`PATCH /api/reviews/{reviewId}/access`](/reference/manage/update-review-access) — 共有先を変える.
- [`PUT /api/reviews/{reviewId}/owner`](/reference/manage/transfer-review-owner) — オーナーを移譲する.

## Search

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

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

## Account

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

- [`GET /api/me`](/reference/account/get-me) — 本人の情報を読む.
- [`GET /api/me/tokens`](/reference/account/list-personal-tokens) — 個人トークンの一覧を読む.
- [`DELETE /api/me/tokens/{tokenId}`](/reference/account/revoke-personal-token) — 個人トークンを取り消す.

## Auth

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

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

## Projects

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

- [`GET /api/projects`](/reference/projects/list-projects) — 案件の一覧を読む.
- [`GET /api/projects/{code}/roles`](/reference/projects/list-project-roles) — 案件の役割を読む.
- [`PATCH /api/projects/{code}/roles`](/reference/projects/change-project-roles) — 案件の役割を付け外しする.
- [`PUT /api/projects/{code}/docs/{reviewId}`](/reference/projects/link-project-document) — 文書を案件に結び付ける.
- [`DELETE /api/projects/{code}/docs/{reviewId}`](/reference/projects/unlink-project-document) — 文書と案件の結び付きを外す.

## Organization

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

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