screenRIG
サインイン開始する

API リファレンス

コメント API

コメント

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

このグループには 9 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

コメント

GET/api/comment/screen/{id}

スクリーンのコメントを取得

指定されたスクリーンに対する不透明なエージェントコメント。ScreenRigは読み取りや使用をしません。認可ではなく実行時マニフェストにもありません。コメントがないスクリーンは comments null を返します。アーカイブ済みスクリーンもアクセス可能です。認証済み/api control-plane 読み取り；1クレジット消費。

認証
projectBearer
リクエスト本文
なし
操作ID
getScreenComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200コメントコメント（application/json）
403

outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/comment/screen/{id}

スクリーンコメントをPUT

指定されたスクリーンの不透明なエージェントコメントを置き換えます。コメント値は、コンパクトなUTF-8形式で最大1024バイトのJSONオブジェクトでなければなりません。コメントフィールドのみ最後の書き込みが勝ちます。リビジョン、updated_at、およびランタイムマニフェストは変更されません。

認証
projectBearer
リクエスト本文
CommentsWrite
操作ID
putScreenComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
comments（必須、オブジェクト）

不透明なエージェントJSONオブジェクト。コンパクトUTF-8シリアル化は最大1024バイト。ネストされたオブジェクト、配列、文字列を許可。配列、文字列、数値、真偽値、nullはコメント値自体としては拒否。

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200コメントコメント（application/json）
403

outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/comment/screen/{id}

スクリーンコメント削除

スクリーンのコメントを解除します。すでに解除されている場合は冪等です。リビジョンの更新やランタイムマニフェストの再発行は行いません。

認証
projectBearer
リクエスト本文
なし
操作ID
deleteScreenComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204未設定本文なし
403

outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/comment/playlist/{id}

プレイリストのコメントを取得

指定されたplaylistに対する不透明なエージェントコメント。ScreenRigは読み取りや使用をしません。コメントがないplaylistは comments null を返します。認証済み/api control-plane 読み取り；1クレジット消費。

認証
projectBearer
リクエスト本文
なし
操作ID
getPlaylistComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200コメントコメント（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/comment/playlist/{id}

プレイリストコメントをPUT

指定されたプレイリストの不透明なエージェントコメントを置き換えます。コメントオブジェクトのコンパクトUTF-8 JSONは最大1024バイトです。コメントフィールドのみ最後に書き込んだものが有効で、リビジョンやランタイムマニフェストは変わりません。

認証
projectBearer
リクエスト本文
CommentsWrite
操作ID
putPlaylistComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
comments（必須、オブジェクト）

不透明なエージェントJSONオブジェクト。コンパクトUTF-8シリアル化は最大1024バイト。ネストされたオブジェクト、配列、文字列を許可。配列、文字列、数値、真偽値、nullはコメント値自体としては拒否。

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200コメントコメント（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/comment/playlist/{id}

プレイリストコメント削除

プレイリストのコメントを解除します。すでに解除されている場合は冪等です。リビジョンを上げず、ランタイムマニフェストを再発行しません。

認証
projectBearer
リクエスト本文
なし
操作ID
deletePlaylistComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204未設定本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/comment/playlist/{id}/page/{page_id}

プレイリストページのコメントを取得

1つのplaylistページに対する不透明なエージェントコメント。ページID文字列で指定。コメントがないページは comments null を返します。playlistまたはページがない場合は not_found。認証済み/api control-plane 読み取り；1クレジット消費。

認証
projectBearer
リクエスト本文
なし
操作ID
getPlaylistPageComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
page_idパス必須プレイリストのページ ID 文字列。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

レスポンス

ステータス意味本文とヘッダー
200コメントコメント（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/comment/playlist/{id}/page/{page_id}

プレイリストページコメントをPUT

1ページのプレイリストにある不透明なエージェントコメントを置き換えます。コメントオブジェクトのコンパクトUTF-8 JSONは最大1024バイトです。そのページのコメントフィールドのみ最後に書き込んだものが有効で、プレイリストのリビジョンやランタイムマニフェストは変わりません。

認証
projectBearer
リクエスト本文
CommentsWrite
操作ID
putPlaylistPageComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
page_idパス必須プレイリストのページ ID 文字列。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
comments（必須、オブジェクト）

不透明なエージェントJSONオブジェクト。コンパクトUTF-8シリアル化は最大1024バイト。ネストされたオブジェクト、配列、文字列を許可。配列、文字列、数値、真偽値、nullはコメント値自体としては拒否。

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

レスポンス

ステータス意味本文とヘッダー
200コメントコメント（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/comment/playlist/{id}/page/{page_id}

プレイリストページコメント削除

1つのプレイリストページのコメントを解除します。すでに解除されている場合は冪等です。リビジョンを上げず、ランタイムマニフェストを再発行しません。

認証
projectBearer
リクエスト本文
なし
操作ID
deletePlaylistPageComments

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
page_idパス必須プレイリストのページ ID 文字列。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

レスポンス

ステータス意味本文とヘッダー
204未設定本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)