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

仮のコメントを取り消す

音声の run(kind: voice)で書いた仮のコメントのうち、自分が書いて、まだ誰も触っていないものだけを取り消せる。 それ以外のコメントは消せない。

DELETE/api/reviews/{reviewId}/comments/{commentId}
Authorization
AuthorizationBearer token · headerrequired

エージェント用トークン。文書とコメントを読み、run の中でコメントを書くのに使う。ブラウザのログインと一緒に送らない。

or
AuthorizationBearer token · headerrequired

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

Path parameters
reviewIdstringrequired

文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。

commentIdstringrequired

コメントの ID。

Request body
requiredapplication/json
runIdstringrequired
Responses
200

取り消した。

400

runId が無い。

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

人のコメントか、エージェントが書いたコメントではない。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

404

文書・run・コメントのいずれかが無い。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

409

not_provisional: 仮のコメントではない。human_touched: 人が触った。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

Request
curl -X DELETE 'https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/comments/comment_example01' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "runId": "string"
}'
Response
取り消した。