コンテンツにスキップ
commentor API
Esc
↑↓移動↵開く⌘Jプレビュー

コメントを横断して探す

自分が見られる全文書(一覧と同じ文書)のコメント本文・引用文・返信から、語を含むものを探す。仮の書き込みと削除済みは対象にしない。個人トークンはどの範囲でも使える。

GET/api/search/comments
Authorization
AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Query parameters
qstringrequired

探す語。前後の空白を除いて 1〜100 文字。全角と半角、ASCII の大文字と小文字の違いは区別しない。

min length 1 · max length 100
limitinteger

返す件数の上限。既定 50、最大 200。

min 1 · max 200 · default: 50
statusstring

open(未解決)か closed(解決済み)。

Allowed:openclosed
sincestring<date-time>

ISO 8601 の日時。コメントの作成・編集と返信のうち最も新しい時刻がこれより後のもの。

authorstring

書いた人の表示名か ID と完全に一致するもの。

aistring

1 なら CLI・API・エージェントから書かれたものだけ。

Allowed:1
humanstring

1 なら CLI・API・エージェント以外から書かれたものだけ。ai と同時には使えない。

Allowed:1
projectstring

案件コード。指定すると、その案件に結び付いた文書だけを返す。大文字・小文字は区別しない。

matches ^[A-Z0-9][A-Z0-9-]{0,31}$
Responses
200

探せた。

hitsobject[]required
Show properties
Array of object
reviewIdstringrequired
titlestringrequired
commentIdstringrequired
messageIdstring | nullrequired

返信で一致したときの返信の ID。

fieldstringrequired

一致した場所。

Allowed:bodyquotereply
snippetstringrequired

一致した前後の文字。

statusstring | nullrequired
Allowed:openclosednull
createdTsstring | nullrequired
totalintegerrequired

上限で切る前の件数。

truncatedbooleanrequired
400

指定が正しくない(invalid_query・invalid_limit・invalid_since・invalid_filter・invalid_project)。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request
curl -X GET 'https://comment-review.fsmarketing.workers.dev/api/search/comments?q=string' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "hits": [
    {
      "reviewId": "review_example01",
      "title": "料金ページ",
      "commentId": "comment_example01",
      "messageId": null,
      "field": "body",
      "snippet": "税込か税抜かを明記してください。",
      "status": "open",
      "createdTs": "2026-10-05T01:16:17.348Z"
    }
  ],
  "total": 1,
  "truncated": false
}