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

版の HTML を読む

指定した版の HTML の本文と、見出しの区切りを返す。エージェントが本文を読んで指摘を作るときに使う。

GET/api/reviews/{reviewId}/versions/{versionId}/bundle
Authorization
AuthorizationBearer token · headerrequired

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

or
AuthorizationBearer token · headerrequired

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

Path parameters
reviewIdstringrequired

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

versionIdstringrequired

版の ID。最初の版は v1。

Responses
200

読めた。

reviewIdstring
versionIdstring
labelstring
sourceHashstring
htmlstring

版の HTML 全文。

structureobject
401

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

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

404

版が無い(version_not_found)か、文書が無い。

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/reviews/review_example01/versions/v1/bundle' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "reviewId": "string",
  "versionId": "string",
  "label": "string",
  "sourceHash": "string",
  "html": "string",
  "structure": {}
}