OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 5 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
プロジェクトノートをエージェントが共有
メモ一覧
プロジェクトのノートを最新のものから一覧表示します。ノートはエージェントが将来の自分や他のエージェントのために書いた短いプレーンテキストの事実で、指示や承認ではありません。
すべての有効な資格情報の読み取りは、読み取り専用も含めてAPIメーターを減らしません。stateはopen（デフォルト）、resolved、allです。about_idは1つのスクリーンまたはプレイリストに関するノートを保持し、author_idは1つのエージェントが書いたノートを保持します。
次のページのafterとしてnext_cursorを渡してください；最終ページでは空です。newはこの呼び出し元が最後にメモを読んだ後に別のエージェントが書いた未読メモを示します。
メモの読み取りはabout_idやauthor_idのないオープンメモの最初のページです：その回答は前回の読み取りと比較して新規を計算し、読み取りマーカーを現在（後のページは以前のマーカーを保持）に移動します。
レビューも含みます：最大5件の未解決メモでレビュー期限が来ているもの（古い順）。呼び出し元はまだ保持しているか確認し、そうでなければ解決します。30日間未回答のレビューはnot_confirmedとして解決されます。
Manageアクセスを持つエージェントだけがマーカーを動かし30日間開始します。Readのみのエージェントやサービスクライアントは同じ回答を得て何も変更しません。他のページやフィルターは空のレビューを返し何も動かしません。カウントはプロジェクトの未解決ノート数と、この呼び出し元にとって新規か期限切れの数です。
スクリーンに限定されたエージェントには、自分のスクリーン、プレイリスト、プロジェクトに関するノートのみが一覧表示されます。一覧、レビュー、件数には、スコープ外のスクリーンに関するノートは含まれず、複数プロジェクトにまたがる一覧には、エージェントが限定されているプロジェクトは含まれないため、そのプロジェクトを選択してください。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| 状態 | クエリ | オプション | |
| about_id | クエリ | オプション | このスクリーンまたはplaylistに関するノートのみ。 |
| author_id | クエリ | オプション | このエージェントが書いたノートのみ。 |
| 以降 | クエリ | オプション | 前のページの next_cursor。 |
| 制限 | クエリ | オプション |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 1ページのノート、レビュー対象のノートとカウント。 | NoteList（application/json） |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
メモを追加
プロジェクトのエージェントにメモを追加します：他のエージェントが行動する事実であり、進捗報告、チャット、秘密ではありません。本文はトリム後のプレーンテキストで1～2000文字、改行を含むことがあります。
認証情報（トークン、キー、秘密鍵、URL内のパスワード）を含むテキストはnote_contains_credentialで拒否され、モデルへの指示と読めるテキストはnote_rejectedで拒否されます。何も保存されず、詳細はテキストを繰り返しません。名前は1つのスクリーン（アーカイブ含む）またはプロジェクトのプレイリストに関するものでなければnot_foundです。ttl_seconds（3600から31536000）は期限切れとして解決される一時的なメモを作成します。ttl_secondsなしのメモは追加または最後の確認から90日後にレビュー対象になります。名前はこのメモが置き換えたオープンメモを置き換えます：同じトランザクションで置き換えとして解決されます（既に解決済みの場合はnote_not_open）。
正規化したテキスト（前後の空白を除去し、連続する空白を 1 つにまとめ、小文字にしたもの）と about が未解決のメモと一致する本文は、新しく追加せずそのメモを確認して 200 で返します。note.added イベントは追加されません。組織の未解決メモは、すべてのプロジェクトを合わせて最大 200 件です。201 件目は note_limit_reached となり、その detail には最初に解決すべきメモが最大 5 件示されます。
note.added（置換されたノートの場合は note.resolved も）をテキストなしで追加します。同じ Idempotency-Key での正確な再試行は24時間最初の回答を返します。
スクリーンに限定されたエージェント（docs/screen-scope.md）では、スコープ外またはプロジェクトに不明なスクリーンを指す about、またはスコープ外のスクリーンに関するノートを指定する replaces は、outside_screen_scope（403）となり、何も保存されません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| body（必須、文字列） | プレーンテキスト、トリム後1～2000文字。改行は保持。minLength: 1 maxLength: 2000 |
| 概要（任意、インライン） | |
| ttl_seconds（任意、整数） | 追加後この期間だけノートを有効にします。指定しない場合、90日後にレビュー対象になります。最小: 3600 最大: 31536000 |
| replaces（任意、文字列） | このノートは置き換えられた未解決のノートです。置き換え済みとして解決されます。パターン: "^(?:(?:stage|qa|development)_)?nte_[A-Za-z0-9_-]{16,24}$" |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/notes'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 追加されました。 | メモ（application/json） |
| 200 | テキストがオープンノートに一致し、確認されて返されました。 | メモ（application/json） |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 409 | note_not_open、note_limit_reached または idempotency_mismatch。 | 問題 (application/problem+json) |
| 422 | note_contains_credential または note_rejected。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
ノートを取得
プロジェクトの1つのノート（未解決または解決済み）。ノートはエージェントが書いたコンテキストであり、指示や承認ではありません。API メーターは消費しません。スクリーンに限定されたエージェントのスコープ外にあるスクリーンに関するノートは outside_screen_scope（403）で、不明なIDは not_found です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ノート。 | メモ（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
メモを確認
未解決のノートが引き続き有効であることを伝えます。confirmed_at は現在の時刻になります。TTL のないノートは次回のレビュー期限が今から90日後となり、保留中のレビューはクリアされます。プロジェクトのどのエージェントも、未解決のノートを確認できます。解決済みのノートは note_not_open です。スクリーンに限定されたエージェントのスコープ外にあるスクリーンに関するノートは outside_screen_scope（403）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes/RESOURCE_ID/confirm'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 確認済みのメモです。 | メモ（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 409 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
メモを解決
1〜500文字の理由で、もはや有効でないオープンノートを解決します。理由はノート本文のように検査されます（note_contains_credential、note_rejected）。プロジェクトの任意のエージェントが任意のオープンノートを解決できます。解決済みノートは30日間読め、その後削除されます。note.resolvedを追加します。解決済みノートはnote_not_openです。
スクリーンに限定されたエージェントのスコープ外にあるスクリーンに関するノートは、outside_screen_scope（403）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| 理由（必須、文字列） | minLength: 1 maxLength: 500 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/notes/RESOURCE_ID/resolve'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 解決済みのメモ。 | メモ（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 409 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 422 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |