OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 84 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
スクリーン
スクリーン一覧
デフォルトのリストはpairing_pendingとactiveのスクリーンを返します。state=archivedを渡すとアーカイブ済みスクリーンのみをリストします。tagを渡すと、そのタグを正確に含むスクリーンのみをリストし、タグなしスクリーンはフィルターがある場合は除外されます。
field を NAME:VALUE の形式でフィールドごとに1回ずつ渡すと、すべての値に一致するフィールドを持つスクリーンのみが一覧表示されます。near を LAT,LON,KM の形式で渡すと、地点から KM キロメートル以内にあるスクリーンのみが一覧表示されます。位置情報のないスクリーンは除外され、すべてのフィルターは state および tag と組み合わせて使えます。
folder にスクリーンフォルダーIDを渡すと、その直下のスクリーンのみを一覧します（サブフォルダーのスクリーンは含みません）。root を渡すと、どのフォルダーにも入っていないスクリーンを一覧します。
スクリーンは新しい順で、1ページあたり最大500件です。next_cursor は、さらに行が残っている間は、最後に返された行の位置です。次のページには、同じフィルターで after として渡してください。最後のページでは next_cursor は null です。スクリーンに限定された呼び出し元（docs/screen-scope.md）には、スコープ内のスクリーンのみが一覧表示されます。
プロジェクトを指定しないリクエストでは、呼び出し元がスクリーンに限定されているプロジェクトは除外されます。一覧に含めるには、プロジェクトを指定してください。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| 状態 | クエリ | オプション | pairing_pendingとactiveは省略します。archivedを渡すとアーカイブされたスクリーンのみをリストします。 |
| タグ | クエリ | オプション | 正確なスクリーンタグ。このフィルターがある場合、タグなしのスクリーンは除外されます。 |
| field | クエリ | オプション | NAME:VALUE（最初のコロンで分割されます）。フィールド NAME の値が VALUE と完全に一致するスクリーンのみが対象です。複数のフィールドを指定するには、パラメーターを繰り返します。すべてが一致する必要があり、同じ名前は1回しか指定できません。形式が正しくないものや重複しているものは、field を示す invalid_request になります。 |
| near | クエリ | オプション | LAT,LON,KM（緯度と経度は10進数の度、距離はキロメートル）。例: 47.6062,-122.3321,25。位置が地点から KM キロメートル以内にあるスクリーンのみが対象です。緯度は -90 から 90、経度は -180 から 180、KM は 0 より大きく 20038 以下です。位置情報のないスクリーンは除外されます。形式が正しくない値は、near を示す invalid_request になります。 |
| フォルダー | クエリ | オプション | スクリーンフォルダーIDはそのフォルダー直下のスクリーンのみを残し、サブフォルダーのスクリーンは含みません。root はどのフォルダーにも入っていないスクリーンのみを残します。省略するとすべてのスクリーンを一覧します。 |
| 以降 | クエリ | オプション | 同じリストの前のページの next_cursor。同じフィルター付き。省略時は最新行から開始。カーソルでない値は invalid_request。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーン | スクリーンリスト（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンフォルダー一覧
プロジェクト内のすべてのスクリーンフォルダーを名前順に最大1000件リストします。
フォルダーはスクリーンを整理し、対象として指定できます。キャンペーンの audience のリーフ {"folder": ID} はそのフォルダーとその中のすべてのフォルダーにあるスクリーンに一致し、フリートアクションのセレクター by:folder は同じスクリーンに作用し、フォルダーの default_playlist_id は、独自のプレイリストを持たないスクリーンが表示するプレイリストです。parent_id はプロジェクトのルートで null です。ツリーは parent_id から構築します。screens は各フォルダー直下のライブスクリーンの数です。
スクリーンのフォルダーは Screen.folder_id です。スクリーンに限定された呼び出し元（docs/screen-scope.md）には、スコープ内のフォルダーとその上位のフォルダーが一覧表示されます。上位のフォルダーは、ツリーにルートがあるように読み取り専用で、スクリーン数は含まれず、兄弟フォルダーは非表示です。プロジェクトを指定しないリクエストでは、呼び出し元がスクリーンに限定されているプロジェクトは除外されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screen-folders'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンフォルダー | ScreenFolderList（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンフォルダーを作成
プロジェクトのルート（parent_id が null または省略）または parent_id の中に、スクリーンフォルダーを1つ作成します。名前はトリムされ、制御文字なしの1～100のUnicode文字で、「.」や「..」ではなく、同じ親の下の兄弟フォルダー間で一意です（resource_conflict）。
組織が保持できるフォルダーは、すべてのプロジェクトを合わせて最大1000個（quota_exceeded）、ネストは最大10階層まで（invalid_request）です。default_playlist_id を設定する場合は、承認済みプレイリストを指定する必要があります（playlist_not_approved）。screen.folder_created を発行します。
スクリーンに限定された呼び出し元（docs/screen-scope.md）がフォルダーを作成できるのは、スコープ内のフォルダーの内側のみです。プロジェクトルートやその他の親は outside_screen_scope です。保護されたフォルダー内にフォルダーを作成すると protected_change レビューとなり（202 pending_review）、2人目の承認者が決定します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name（必須、文字列） | トリム済み；1～100のUnicode文字、制御文字なし、「.」や「..」は不可、同じ親の下の兄弟フォルダー間で一意。minLength: 1 maxLength: 100 |
| parent_id（任意、インライン） | 作成先のフォルダー。null または省略するとプロジェクトのルートです。 |
| default_playlist_id（任意、文字列） | フォルダー内で独自のプレイリストを持たないスクリーン向けの承認済みプレイリスト。minLength: 1 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screen-folders'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | フォルダーを作成しました。 | ScreenFolder（application/json）；ヘッダー：ETag |
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています（docs/reviews.md）。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します（docs/screen-scope.md）。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending（application/json） |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンフォルダーを取得
スクリーンに限定された呼び出し元（docs/screen-scope.md）は、スコープ内のフォルダーとその上位のフォルダーを読み取ります。それ以外のフォルダーと不明なIDは outside_screen_scope です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screen-folders/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 1つのスクリーンフォルダー。 | ScreenFolder（application/json）；ヘッダー：ETag |
| 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) |
スクリーンフォルダーを更新
フォルダーの名前を変更し（name）、中身すべてと共に移動し（parent_id。null はプロジェクトのルート）、または独自のプレイリストを持たないスクリーンが表示するデフォルトプレイリストを設定します（default_playlist_id。null で解除）。フォルダーは自身またはその内部のフォルダーに移動できず、移動後はすべてのフォルダーが10階層以内でなければなりません（invalid_request）。
移動またはデフォルトの変更により、内側のスクリーンが約15秒以内に再解決され、レスポンスの levels には、それらのスクリーンが得る、または失うキャンペーンとフォルダーのデフォルトが示されます。変更によりフォルダーのリビジョンが進み、screen.folder_updated が発行されます。同じ値の場合は何も行われません。
If-Match は任意でリビジョンを保護します。protected が true の場合はフォルダーとその内側のすべてのフォルダーを保護し、false で解除します。単独で送信してください（そうでない場合は invalid_request）。設定できるのは承認できる人だけで、エージェント、サービスクライアント、承認できないメンバーには approver_required が返されます。
変更により screen.folder_protection_changed が追加されます（詳細は folder_id、protected）。保護の解除、および保護されたスクリーンを含むフォルダーの移動やデフォルトプレイリストの変更は、protected_change レビューとなり（202 pending_review）、2人目の承認者が決定します。
スクリーンに限定された呼び出し元（docs/screen-scope.md）が変更できるのは、スコープ内のフォルダーのみです。parent_id もスコープ内のフォルダーを指定する必要があり（ルートは outside_screen_scope）、スコープが指定するフォルダーの protected は変更できません。protected が true の場合は保護フォルダーであり、Enterprise プランに含まれます。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。
設定された保護は、変更を2人目の承認者のために保留し続けます。保護の解除を求める操作は、すべてのプランでレビューになります。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name（任意、文字列） | トリム済み；1～100のUnicode文字、制御文字なし、「.」や「..」は不可、同じ親の下の兄弟フォルダー間で一意。minLength: 1 maxLength: 100 |
| parent_id（任意、インライン） | フォルダーをこのフォルダーに移動します。null はプロジェクトのルートです。 |
| default_playlist_id（任意、インライン） | フォルダー内で独自のプレイリストを持たないスクリーン向けの承認済みプレイリスト。null で解除します。 |
| protected（任意、ブール値） | フォルダーとその内側のすべてのフォルダーを保護します（docs/screen-scope.md）。設定できるのは承認できる人だけです。単独で送信してください。ほかのメンバーと一緒に送ると invalid_request です。保護されたフォルダーの保護を解除すること自体が保護された変更であり、2人目の承認者が決定するレビューになります（202 pending_review）。 |
リクエストテンプレートとレスポンス
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screen-folders/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | フォルダーを更新しました。 | ScreenFolder（application/json）；ヘッダー：ETag |
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています（docs/reviews.md）。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します（docs/screen-scope.md）。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending（application/json） |
| 402 | feature_not_in_plan — 保護フォルダーは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (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つ削除します。中身は削除されません。そのスクリーンとフォルダーは削除したフォルダーの親（親がなければプロジェクトのルート）に移動し、移動した各フォルダーはリビジョンが進み、それらのスクリーンは再解決されます。
キャンペーンの audience がそのフォルダーを指定している間は resource_conflict で拒否されるため、スケジュールが気付かないうちにスクリーンを失うことはありません。先にそれらのキャンペーンを変更または削除してください。そのスクリーンが得た、または失ったレベルを返します。screen.folder_deleted を発行します。If-Match はリビジョンを任意で保護します。
スクリーンに限定された呼び出し元（docs/screen-scope.md）が削除できるのは、スコープ内にあり、スコープ自体が指定していないフォルダーのみです（outside_screen_scope）。内側のスクリーンは親フォルダーに移ります。保護されたフォルダー、または保護されたスクリーンを含むフォルダーの削除は protected_change レビューとなり（202 pending_review）、2人目の承認者が決定します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screen-folders/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 削除されました。内容は親に移動しました。levels には、そのフォルダーのスクリーンが得た、または失ったフォルダーのデフォルトプレイリストが示されます。 | ScreenFolderDeleteResult (application/json) |
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています（docs/reviews.md）。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します（docs/screen-scope.md）。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending（application/json） |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンを移動
スクリーン（screen_ids）とフォルダー（folder_ids）を1つのフォルダー（folder_id）に、または folder_id が null の場合はプロジェクトのルートに移動します。最大1000個の ID を1つのリクエストで扱い、全件成功か全件失敗のどちらかです。すべての ID が存在する必要があります（not_found）。フォルダーは自身またはその内部のフォルダーに移動できず、移動後はすべてのフォルダーが10階層以内でなければなりません（invalid_request）。
すでに移動先にあるアイテムはそのままにし、移動した各スクリーンとフォルダーはリビジョンが進みます。移動したスクリーンは約 15 秒以内にプレイリストを再解決します。levels には、スクリーンが入る、または出るフォルダーのオーディエンスを持つキャンペーンと、スクリーンが得る、または失うフォルダーのデフォルトプレイリストが示されます。
screen.moved を発行します。その details には、件数 (screens、folders) と、移動した各アイテムの元の場所が含まれます: moves [{screen_id, from}] (from はフォルダー ID で、ルートの場合は空) と folder_moves [{folder_id, from_parent}] で、それぞれ最大 1000 件です。履歴からこのルートで元に戻せます。
スクリーンに限定された呼び出し元（docs/screen-scope.md）は、スコープ内のスクリーンとフォルダーを、スコープ内のフォルダーへ移動します。スコープ外のIDや移動先、プロジェクトルートがあると移動全体が拒否され（outside_screen_scope）、確認から書き込みまでの間にスクリーンがスコープから外れた場合も同様です。
保護されたフォルダーへの、またはそこからの移動は、protected_change レビューとなり（202 pending_review）、2人目の承認者が決定します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| folder_id（必須、インライン） | 移動先のフォルダー。null はプロジェクトのルートです。 |
| screen_ids（任意、array） | |
| folder_ids（任意、配列） |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/move'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 移動したスクリーンとフォルダーの数と、移動したスクリーンが得る、または失う levels。 | ScreenMoveResult（application/json） |
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています（docs/reviews.md）。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します（docs/screen-scope.md）。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending（application/json） |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スケジュールカレンダーを取得
ダッシュボードのスケジュールカレンダー向けに、対象のスクリーンが [from, to) の間に何を再生するかとその理由を返します。screen_id、folder_id（フォルダーとその内側のすべてのフォルダーにあるスクリーン）、tag、campaign_id（そのオーディエンスのスクリーン）のうち、ちょうど 1 つを指定します。
スタックの入力が同一のスクリーン（同じレベル、デフォルト、タイムゾーン、ディスプレイ数）は 1 つのグループとタイムラインを共有するため、大きな対象でも数十本のタイムラインで済みます。グループには最大 500 台のスクリーン、応答には最大 200 グループが含まれます（truncated）。
各グループは、優先度の高い順のスタック（テイクオーバー、スクリーンに届くキャンペーン、スクリーン自身のスケジュールエントリー、続いてデフォルトのプレイリストまたは最も近いフォルダーのもの）、各レベルの区間（対象のすべてのディスプレイで再生する、再生するディスプレイが一部のみの partial、outranked、または操作や Player だけが観測するデータ条件を待つ間の conditional）、各ディスプレイに表示される内容（on_screen。フルページの場合はメイン領域）、および競合（同じ優先度の 2 つのキャンペーンが同時に成立する場合、成立しているのに再生されないレベル）を持ちます。from と to は RFC 3339 の時刻で、to は from より後、間隔は最大 93 日です。分未満は切り捨てられます。
ルールは、スイープとすべてのPlayerが読み取るのと同じように、各グループのタイムゾーンで読み取られます。すべてのレベルが再生可能と判断されます。スクリーンに限定された呼び出し元（docs/screen-scope.md）は、スコープ内の screen_id または folder_id を送信する必要があります。タグ、campaign_id、対象なしは outside_screen_scope です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| 開始 | クエリ | 必須 | |
| から | クエリ | 必須 | |
| screen_id | クエリ | オプション | |
| folder_id | クエリ | オプション | |
| タグ | クエリ | オプション | |
| campaign_id | クエリ | オプション |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/schedule/calendar?from=FROM&to=TO'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 対象のカレンダー。 | ScheduleCalendar（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) |
スクリーンをペアリング
フリート全体で有効な6文字のPlayerペアリングセッションを1つ請求します。同一のIdempotency-Keyによる再試行は、クォータを再消費せずに元の結果を返します。
ダッシュボードセッションは、同じ本文、Idempotency-Key、予算、問題で現在のプロジェクトにクレームしますが、不明なコードまたはすでにクレーム済みのコードの not_found が CLI コマンドを示さない点が異なります。これは状態の変更であるため、ダッシュボードの変更ルールに従い、スタッフの書き込みモードがないシャドウセッションは拒否され、クレームが追加するイベントにはダッシュボードのユーザーが示されます。folder_id は、スクリーンが配置されるフォルダーを指定します。
スクリーンに限定された呼び出し元（docs/screen-scope.md）は、スコープ内のフォルダーを送信する必要があり、ペアリングできるのは承認できる人としてのみです（outside_screen_scope、approver_required）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| code（必須、文字列） | パターン: "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{6}$" |
| ラベル（任意、文字列） | minLength: 1 maxLength: 120 |
| folder_id（任意、文字列） | スクリーンが配置されるスクリーンフォルダー。省略するとプロジェクトルートに配置されます。スクリーンに限定された呼び出し元は、スコープ内のフォルダーを送信する必要があります（そうでない場合は outside_screen_scope）。プロジェクトに存在しないフォルダーは、プロジェクト全体の呼び出し元では invalid_request です。 冪等リクエストの一部です。同じ Idempotency-Key で別の folder_id を指定すると idempotency_mismatch になります。minLength: 1 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/pair'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 永続的なpairing_pendingスクリーンクレーム。 | PairingClaim（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 413 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 500 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンのプロビジョニング
ブラウザー専用の新しいスクリーンのプロビジョニング（任意）。常に pairing_pending スクリーンを1つ新しく作成します。同時にペアリングを待てるのは最大5台です（quota_exceeded）。正確な再試行は、同じフラグメントトークンを10分間再送します。6文字のペアリングが、引き続きデフォルトで唯一の復旧フローです。folder_id は、スクリーンが配置されるフォルダーを指定します。
スクリーンに限定された呼び出し元（docs/screen-scope.md）は、スコープ内のフォルダーを送信する必要があります（そうでない場合は outside_screen_scope）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| ラベル（任意、文字列） | minLength: 1 maxLength: 120 |
| folder_id（任意、文字列） | PairScreen と同様に、スクリーンが配置されるスクリーンフォルダー。minLength: 1 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/provision'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 新しいブラウザプロビジョニングリンク。 | スクリーンプロビジョニング（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 410 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 413 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 500 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (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つのアクションを適用します。スクリーン数の上限はありません。ユニークなscreen_idsまたは作成順にアクティブなスクリーンにマッチするタグを選択します。解決された選択は変異前に固定され、制限されたチャンクに保存され、Idempotency-Keyの下で24時間保持されます。
各ステップは単一スクリーンの変更経路を使い、リビジョン、イベント、実行時シグナル、スクリーンごとの制限を保持します。レスポンスには1ページ分の結果が含まれ、マッチ数、成功数、失敗数はそのページを示します。HTTP 202 には合計、オフセット、next_cursorが含まれます。同じセレクター、アクション、Idempotency-Keyで続行し、next_cursorをafterとして渡します。
Retry-Afterが存在する場合は必ず反映します。結果が0件のページも含みます。応答にはIdempotency-Keyが含まれ、呼び出し元が省略した場合も生成されたキーを返します。継続時はこのキーを保持してください。HTTP 200 で選択が完了します。応答済みページは、各スクリーンの失敗も含めて正確に再現されます。中断されたステップは、効果を繰り返さずに再実行されます。
大きな操作は既存の組織ごとの600回/分の予算に対してペース配分されます（リロード、トースト、テイクオーバー、プレイリストスケジュール、再起動、ディスプレイおよびディスプレイスケジュール）。組織の予算枯渇は操作を停止し、フリートを拒否しません。スクリーンごとの枯渇はそのスクリーンのみ失敗します。
フォーマットを持つプレイリストを、形状の異なるウォールのスクリーンに結び付ける割り当て、テイクオーバー、または set_playlist_schedule ステップは、そのスクリーンのみ 409 playlist_format_mismatch で失敗します。割り当てとタグの変更にはメッセージ予算がありません。
ページ内のいずれかのスクリーンにないスクリーントークンを読み取る iframe の src またはアプリケーションの params を持つプレイリストの割り当ては、そのページに screen_fact_missing 警告を追加します（warnings、PlaylistWarning）。部分的な失敗は通常の結果です。1つのキーによるすべてのページと再試行は、1回の従量課金アクションです。
リクエストは制限されたバイトペイロードを使用します。輸送ペイロードより大きい選択にはタグを使用してください。不正なセレクターやアクションはスクリーンに触れる前に拒否されます。
スクリーンに限定された呼び出し元（docs/screen-scope.md）は、screen_ids またはフォルダーで選択し、すべてスコープ内のスクリーンである必要があります。タグセレクター、スコープ外のスクリーン、不明なスクリーンがあると、何かが固定または提案される前にアクション全体が拒否されます（outside_screen_scope）。
保護されたスクリーンに及ぶ assign、takeover、takeover_clear、set_playlist_schedule、clear_playlist_schedule は、すべてのアクセスレベルで、2人目の承認者が決定するレビューになります（202 pending_review）。保護されたスクリーンの set_tags、add_tags、remove_tags、toast、display、display_clear、set_display_schedule、clear_display_schedule は protected_target（409）です。
一時停止中のエントリ（下書き）を持つ set_playlist_schedule アクションはスケジュールの変更管理であり、Enterprise プランに含まれます。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
| 以降 | クエリ | オプション | 前の結果ページの next_cursor。元の Idempotency-Key とリクエスト本文を再利用してください。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| selector（必須、ScreenActionSelector） | |
| アクション（必須、ScreenAction） | タイプで識別される1つのフリートアクション。各メンバーは自身のパラメータのみを持ち、他タイプのメンバーは未知フィールドでinvalid_requestです。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/actions'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンごとの結果。部分成功は正常な回答です。 | スクリーンアクション結果（application/json）；ヘッダー：Idempotency-Key、Cache-Control、RateLimit-Policy、RateLimit |
| 202 | さらにスクリーンが残っています（next_cursor と同じ Idempotency-Key および本文で続行し、Retry-After に従ってください）。または、status が pending_review の場合は、提案アクセスでアクションがレビューになった（docs/reviews.md）か、任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶためにレビューになったことを示します（docs/screen-scope.md）。 assign、takeover、takeover_clear、set_playlist_schedule、clear_playlist_schedule のみがレビューになります。他のアクションは Propose に対して insufficient_access です。 | インライン（application/json）；ヘッダー：Idempotency-Key、Retry-After、Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 402 | feature_not_in_plan — enabled が true の set_reboot_schedule（予定された再起動）と、displays のロックを伴う set_playlist_schedule（ビデオウォール）は Plus に含まれます。クリア用のアクションと単発のコマンドは利用できます。payment_required — プロジェクトにクレジットが残っていません。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 403 | insufficient_access。スクリーンに限定された呼び出し元がスコープ外を選択した場合は outside_screen_scope。承認できない、スクリーンに限定されたメンバーの場合は approver_required。 | 問題 (application/problem+json) |
| 409 | playlist_format_mismatch とそのアクションのその他の競合。または、set_tags、add_tags、remove_tags、toast、display、display_clear、set_display_schedule、clear_display_schedule が保護されたスクリーンフォルダー内のスクリーンに及ぶ場合は protected_target。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンを取得
pairing_pending、アクティブ、およびアーカイブされたスクリーンを返します。削除されたスクリーンは見つかりません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/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) |
スクリーンを更新
スクリーンの name、playlist_id、timezone、wall、tags、fields、location、log_level、toast_level、display、kiosk を更新します。タグの変更は levels を返します。スクリーンが加わる、または外れるキャンペーンと、各キャンペーンの変更前後の到達範囲です。wall はスクリーンのビデオウォール (オブジェクト) を設定するか、クリア (null) します。
設定するには、display.wall ホスト機能を宣言したプレーヤーが必要で、そうでない場合は 409 wall_unsupported になります。
変更するとマニフェストのリビジョンが再発行され、details.wall（ウォールのオブジェクト。クリアされた場合は null）を含む screen.updated が追加されます。fields はスクリーン自身の値にマージされ（文字列でフィールドを設定、null でフィールドを削除、fields 自体を null にするとすべてのフィールドをクリア）、location はスクリーンの場所を設定します（null でクリア）。
どちらかを変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行され、カードの配置が {screen.…} トークンを再び展開します。あわせて screen.updated を追加し、details.fields（新しいオブジェクト全体。クリアされた場合は {}）または details.location（新しいオブジェクト。クリアされた場合は null）を含めます。
文法が拒否する名前や値、または 33 個目のフィールドは、それを示す invalid_request になります。log_level (debug、info、warn、error) と toast_level (info、alert、error) は、Player が生成または表示する最も低いレベルを設定し、null でそれぞれ解除します。それ以外の値は invalid_request です。
どちらかを変更すると、マニフェストのリビジョンが再発行され、ルートメンバー verbosity として両方が含まれます。display はディスプレイのアイドル時の暗転と明るさの設定を設定またはクリアします。display.idle {after_s, wake} は、タッチやキー操作がないまま、または wake に presence がある場合は画面の前に誰もいないまま after_s 秒（30〜86400）が経過すると画面を暗転させ、復帰イベント (touch、presence、または両方。それぞれ 1 回ずつ) で即座に点灯させます。display.brightness {mode} は auto（デバイスの光センサーが明るさを設定）または fixed（デフォルト、オペレーターの明るさ）です。
送信したメンバーはそれを置き換え、null はそれをクリアし、省略したメンバーはそのままで、display が null の場合は両方がクリアされます。kiosk {lock} が true なら Player を画面に固定し (Android の画面固定)、false または null なら解除します。ディスプレイスケジュールとオーバーライドは独自のルートを持ち、display メンバーで schedule や override を指定すると invalid_request になります。
範囲外の値または型が正しくない値は、パス (display.idle.after_s) を示す invalid_request になります。
いずれかを変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行され、すべてのスクリーンのマニフェスト ETag が変わります。マニフェストは display.idle と display.brightness をルートの display メンバーに、ロックをルートメンバー kiosk として含み、screen.manifest_changed が追加されます。スクリーンはそれらを Screen.display.idle、Screen.display.brightness、Screen.kiosk として読み戻します。
バックエンドは、Player に関係なく送信された内容を保存します。Player は、ホスト機能が display_power.idle、brightness.auto、kiosk_lock を宣言している場合にのみ設定を適用し、古い Player はこれらを無視します。スクリーンのウォールとフォーマットが合わないプレイリストを割り当てると 409 playlist_format_mismatch になります。
Propose アクセスでは、playlist_id だけのパッチはレビューになり (202 pending_review)、wall、fields、location、display、kiosk を含むそれ以外のフィールドは insufficient_access になります。承認済みバージョンのないプレイリストは playlist_not_approved です。
スクリーンが次に表示するプレイリストに、そのスクリーンにないスクリーントークンを読み取る iframe の src またはアプリケーションの params がある場合、応答には screen_fact_missing 警告（warnings、PlaylistWarning）が含まれ、スクリーンのマニフェストからそのプリミティブが除外されます。
保護されたスクリーンでは、アクセスレベルにかかわらず、playlist_id は2人目の承認者が決定するレビューになり (202 pending_review)、単独で送信する必要があります (name と併用すると invalid_request)。tags、fields、location、timezone、wall、display は protected_target (409) となり、playlist_id と併用しても同様です。名前の変更は引き続き即時に反映されます。アーカイブ済みスクリーンで playlist_id をクリアする (null) と 409 screen_archived になります。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name（任意、文字列） | minLength: 1 maxLength: 120 |
| playlist_id（任意、インライン） | スクリーンのデフォルト: プレイリスト ID で割り当て、null で解除し、省略すると維持します。テイクオーバー、キャンペーン、スケジュール、フォルダーから継承したデフォルトが優先されます。有効なコンテンツがない場合、ペアリング済みの Player は待機画面を表示します。 |
| タイムゾーン（任意、文字列） | IANAタイムゾーン識別子。例：America/Los_Angeles。これはこのスクリーンのすべてのページ可視性ルールが評価されるゾーンです。変更するとマニフェストのリビジョンが再発行されます。ページ可視性を使用するプレイリストが割り当てられたスクリーンは必ず持つ必要があります。minLength：1 maxLength：64 |
| wall（任意、インライン） | スクリーンのビデオウォール。null でクリア。設定には display.wall ホスト機能を宣言した Player が必要。そうでない場合は 409 wall_unsupported。変更するとマニフェストリビジョンが再発行されます。 |
| タグ（オプション、ScreenTags） | フリートセレクタータグ（0〜16件の一意なタグ、各タグはメディアタグ構文に準拠）。ScreenPatch では配列全体が置き換えられ、空配列で全タグがクリアされます。重複や不正なタグはinvalid_requestです。タグを変更するとスクリーンのリビジョンが更新され（If-Matchで保護）、screen.updatedにdetails.tagsが追加されます。マニフェストリビジョンは変更されません。 タグはランタイムマニフェストにも認証にも決して含まれません。 |
| fields（任意、inline） | 店舗番号や地域など、スクリーン固有の値にマージされます。文字列はフィールドを設定し、null はフィールドを削除し、fields 自体が null の場合はすべてのフィールドをクリアします。名前は、小文字の英字、数字、アンダースコアからなる1〜32文字です。値は、前後の空白を除いて1〜200文字です。1つのスクリーンに設定できるフィールドは最大32個です。 フィールドを変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行されます。カードの配置は {screen.field.NAME} トークンを通じてこれらを読み取ります。 |
| location（任意、inline） | スクリーンの場所です。null を指定するとクリアされます。変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行されます。カードの配置は {screen.location} トークンを通じてこれを読み取ります。 |
| log_level（任意、インライン） | スクリーンの Player が生成する最も低いログレベル。それより下の行は書き込まず、エラー行は常に生成されます。null で解除されます (Player のデフォルト)。変更するとマニフェストのリビジョンが再発行され、verbosity.logLevel として含まれます。 |
| toast_level（任意、インライン） | スクリーンの Player が表示する最も低いトーストレベル。それより下ではトーストを表示せず、エラーのトーストは常に表示されます。null で解除されます (すべてのトーストを表示)。変更するとマニフェストのリビジョンが再発行され、verbosity.toastLevel として含まれます。 |
| display（任意、インライン） | ディスプレイのアイドル時の暗転と明るさの設定 (display.idle、display.brightness)。送信したメンバーはそれを置き換え、null はそれをクリアし、省略したメンバーはそのままです。display が null の場合は両方がクリアされます。どちらかを変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行され、マニフェストはそれらをルートの display メンバーに含めます。 保護されたスクリーンでは protected_target になります。 |
| kiosk（任意、インライン） | キオスクロック (kiosk.lock)。lock が true なら Player を画面に固定し、false または null なら解除します。変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行され、マニフェストはそれをルートメンバー kiosk として含めます。 |
リクエストテンプレートとレスポンス
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています（docs/reviews.md）。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します（docs/screen-scope.md）。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending（application/json） |
| 200 | スクリーン | スクリーン（application/json） |
| 402 | feature_not_in_plan — ビデオウォールは Plus に含まれます。スクリーン自身のものとは異なるウォールの設定には Plus が必要で、null によるクリアはすべてのプランで行えます。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| 409 | protected_target - 変更が保護されたスクリーンフォルダー内のスクリーンに及び、レビューの形式がありません（docs/screen-scope.md）。レビューを通じてフォルダーの保護を解除し、変更を行い、フォルダーを再度保護してください。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーン削除
対象のスクリーンをソフト削除し、即座にクッキー資格情報とランタイム権限を取り消します。通常の読み取りはnot_foundを返し、墓標付き行は90日以上保持されてからクリーンアップされます。If-Matchはリビジョンを保護し、Idempotency-Keyは結果を再生します。
ネイティブのIDバインドスクリーンは screen_archive_required を返します。そのバインドを保持するにはアーカイブを使用してください。すでにアーカイブ済みのIDバインドスクリーンはアーカイブされたままです（同じ問題が返され、その旨が示されます）。このルートは、ネイティブ登録を解放するための管理者の緊急アクセス権限を付与しません。保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | スクリーンをソフト削除しました。トゥームストーンは少なくとも90日間保持されます。 | 本文なし |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 409 | ネイティブのIDバインドスクリーンの場合は screen_archive_required。または、スクリーンが保護されたスクリーンフォルダー内にある場合は protected_target（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
パッチスクリーンタグ
サインインしたユーザーがスクリーンのタグを設定します。tags は新しい完全なセットです。空の配列はタグをクリアし、不正な形式や重複したタグは tags[i] の invalid_request となります。
updateScreenが行うタグ変更です。ダッシュボードセッションでスクリーン改訂が1つ進み、screen.updatedはdetails.tagsと人物をアクターとして持ち、マニフェスト改訂は変わりません。pairing_pending、active、archivedのスクリーンが受け入れます。
本文にほかのメンバーはありません。セッションは patchScreenName でスクリーン名を変更し、patchScreenPlaylist でそのプレイリストを割り当てられますが、タイムゾーンは変更できません。If-Match はスクリーンのリビジョンを保持し、必須です（欠如時は invalid_request、古い場合は revision_conflict）。
ダッシュボードセッションのみ。エージェントは updateScreen または set_tags、add_tags、remove_tags のフリート操作でタグを変更します。tag を指定した listScreens は、新しいタグでスクリーンを見つけます。保護されたスクリーンでは、変更は protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| タグ（必須、ScreenTags） | フリートセレクタータグ（0〜16件の一意なタグ、各タグはメディアタグ構文に準拠）。ScreenPatch では配列全体が置き換えられ、空配列で全タグがクリアされます。重複や不正なタグはinvalid_requestです。タグを変更するとスクリーンのリビジョンが更新され（If-Matchで保護）、screen.updatedにdetails.tagsが追加されます。マニフェストリビジョンは変更されません。 タグはランタイムマニフェストにも認証にも決して含まれません。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/tags'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンのフィールドを部分更新
サインイン済みのユーザーは、updateScreen のマージパッチでスクリーンのフィールドを変更します。文字列を指定するとフィールドが設定され、null を指定すると削除され、fields に null を指定するとすべてのフィールドがクリアされます。拒否された名前や値、または33個目のフィールドは、fields または fields.NAME で invalid_request になります。
スクリーンのリビジョンが1つ進み、プレイリストを表示するスクリーンには新しいマニフェストリビジョンが付与され、イベントには details.fields と、実行者としてのユーザーが含まれます。本文にほかのメンバーはありません。If-Match にはスクリーンのリビジョンを指定します。必須です（欠けている場合は invalid_request、古い場合は revision_conflict）。
ダッシュボードセッションのみ。エージェントは PATCH /api/screens/{id}（updateScreen）を使用します。保護されたスクリーンでは、変更は protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| fields（必須、インライン） | 店舗番号や地域など、スクリーン固有の値にマージされます。文字列はフィールドを設定し、null はフィールドを削除し、fields 自体が null の場合はすべてのフィールドをクリアします。名前は、小文字の英字、数字、アンダースコアからなる1〜32文字です。値は、前後の空白を除いて1〜200文字です。1つのスクリーンに設定できるフィールドは最大32個です。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/fields'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンの場所を部分更新
サインイン済みのユーザーは、updateScreen の location でスクリーンの場所を設定またはクリアします。latitude と longitude、および任意の name と address を持つオブジェクトを指定すると場所全体が置き換えられ、null を指定するとクリアされます。メンバーの欠落や型の誤り、範囲外の座標、40文字を超える name、200文字を超える address は、location.MEMBER で invalid_request になります。
スクリーンのリビジョンが1つ進み、プレイリストを表示するスクリーンには新しいマニフェストリビジョンが付与され、イベントには details.location と、実行者としてのユーザーが含まれます。本文にほかのメンバーはありません。If-Match にはスクリーンのリビジョンを指定します。必須です（欠けている場合は invalid_request、古い場合は revision_conflict）。
ダッシュボードセッションのみ。エージェントは PATCH /api/screens/{id}（updateScreen）を使用します。保護されたスクリーンでは、変更は protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| location（必須、インライン） | スクリーンの場所：オブジェクトを指定すると場所全体が置き換えられ、null を指定するとクリアされます。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/location'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンの詳細度を変更
サインイン中のユーザーは、updateScreen の log_level (debug、info、warn、error) と toast_level (info、alert、error) で、スクリーンのログレベルとトーストレベルを設定または解除できます。文字列でレベルを設定し、null で解除し、省略したメンバーはそのままです。それ以外の値は、log_level または toast_level で invalid_request になります。
スクリーンのリビジョンが 1 つ進み、プレイリストを表示しているスクリーンには新しいマニフェストのリビジョンが付き、Player はマニフェストのメンバー verbosity からレベルを読み取ります。本文には 2 つのメンバーのうち少なくとも 1 つを指定し、それ以外は指定しません。If-Match はスクリーンのリビジョンを運び、必須です (ない場合は invalid_request、古い場合は revision_conflict)。
ダッシュボードのセッションのみです。エージェントは PATCH /api/screens/{id} (updateScreen) を使います。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| log_level（任意、インライン） | スクリーンの Player が生成する最も低いログレベル。エラー行は常に生成されます。null で解除されます (Player のデフォルト)。変更するとマニフェストのリビジョンが再発行されます。 |
| toast_level（任意、インライン） | スクリーンの Player が表示する最も低いトーストレベル。エラーのトーストは常に表示されます。null で解除されます (すべてのトーストを表示)。変更するとマニフェストのリビジョンが再発行されます。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/verbosity'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンデバイス設定を更新
サインイン中のユーザーは、updateScreen の display メンバーと kiosk メンバーで、スクリーンのアイドル時の暗転と明るさの設定およびキオスクロックを設定または解除できます：display.idle {after_s は 30〜86400、wake は touch、presence または両方}、display.brightness {mode は auto または fixed}、kiosk.lock。
送信したメンバーはそれを置き換え、null はそれをクリアし、省略したメンバーはそのままです。display が null の場合は両方がクリアされます。範囲外の値または型が正しくない値は、パス (display.idle.after_s) を示す invalid_request になります。
スクリーンのリビジョンが 1 つ進み、プレイリストを表示しているスクリーンには新しいマニフェストのリビジョンが付与され、Player はマニフェストのメンバー display (idle、brightness) と kiosk から設定を読み取ります。本文は display と kiosk の少なくとも一方を指定し、それ以外のメンバーは指定しません。
If-Match にはスクリーンのリビジョンを指定し、必須です（ない場合は invalid_request、古い場合は revision_conflict）。保護されたスクリーンでの display の変更は protected_target (409) になります。ダッシュボードセッション専用です。エージェントは PATCH /api/screens/{id} (updateScreen) を使います。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| display（任意、インライン） | display.idle と display.brightness。updateScreen の display と同じです：送信したメンバーはそれを置き換え、null はそれをクリアし、省略したメンバーはそのままです。display が null の場合は両方がクリアされます。どちらかを変更すると、プレイリストを表示しているスクリーンのマニフェストのリビジョンが再発行されます。保護されたスクリーンでは protected_target になります。 |
| kiosk（任意、インライン） | kiosk.lock。updateScreen の kiosk と同じです：lock が true なら Player を画面に固定し、false または null なら解除します。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/device-settings'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーン名を変更
サインイン中の人物は、updateScreen の name でスクリーンの名前を変更します。名前は前後の空白が除去され、制御文字を含まない1〜120文字である必要があり、そうでない場合は name で invalid_request になります（name がない場合や null の場合も同様です）。
スクリーンのリビジョンが1つ進み、イベントは screen.manifest_changed で、スクリーン宛て、操作者はその人物です。マニフェストのリビジョンは変わらないため再生には影響せず、Player は変更された ETag から名前を更新します。同じ名前への変更でもリビジョンは進み、screen.updated が追加されます。本文にほかのメンバーはありません。
If-Match はスクリーンのリビジョンを保持し、必須です（欠如時は invalid_request、古い場合は revision_conflict）。ダッシュボードセッション専用で、エージェントは PATCH /api/screens/{id}（updateScreen）を使います。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name（必須、文字列） | スクリーンの名前（前後の空白は除去）。除去後に1〜120文字で、制御文字を含みません。minLength: 1 maxLength: 120 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/name'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+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) |
スクリーンのプレイリストを変更
サインインした本人が updateScreen の割り当てで画面のプレイリストを割り当てます。プレイリストはプロジェクトに属し、承認済みのバージョンがある必要があります（playlist_not_approved）。フォーマット付きのプレイリストには、同じ形のウォールを持つ画面が必要です（409 playlist_format_mismatch）。
The screen revision moves by one and the manifest is reissued from the new playlist; while a takeover, a campaign or a schedule entry is effective the playlist becomes the default behind it. Events carry the person as their actor.
The write is live, so only the project owner or a member who can approve makes it (approver_required); a staff session needs its write lease. The body has no other member. If-Match carries the screen revision and is required (invalid_request when absent, revision_conflict when stale).
ダッシュボードセッションのみ。エージェントは PATCH /api/screens/{id}（updateScreen）を使用します。保護されたスクリーンでは、承認者による割り当ては、2人目の承認者が決定するレビューになります（202 pending_review）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | スクリーンの現在のリビジョン。引用符付きまたは素の状態（最後に読み取った ETag）。古いリビジョンは revision_conflict と current_revision です。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| playlist_id（必須、インライン） | スクリーンのデフォルトプレイリスト。null で自身の割り当てを解除します。テイクオーバー、キャンペーン、スケジュールのエントリ、フォルダーから継承したデフォルトがあればコンテンツを表示できます。なければペアリング済みの Player は待機画面を表示します。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/playlist'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているスクリーン。ETag はその改訂を示します。 | スクリーン（application/json）；ヘッダー：ETag |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています（docs/reviews.md）。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します（docs/screen-scope.md）。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーン公開IDを回転
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/public-id/rotate'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 公開URLの資格情報がローテーションされました。プレーヤーの公開鍵登録は保持されます。すべてのランタイムセッションは新しいcontent_access_generationで無効化され、ライブのdesiredおよびactive権限は変更されていないマニフェストリビジョンに対してその世代で再発行されます。したがって、セッションを再発行するペアリング済みプレーヤーは既に表示中のコンテンツの認証を維持します。 | スクリーン（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) |
画面リンクを取得
スクリーンのリンク。ストレージを保持しないブラウザー（vMix や OBS のブラウザーソースなど）でこのスクリーンを開く Player URL。url は認証情報で、Manage 有効未満では空になり url_redacted は true です。screens ケイパビリティそのものが必要です。スクリーンにリンクがない場合は screen_link_not_found。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/screens/RESOURCE_ID/link'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンのリンク。 | ScreenLink（application/json）；ヘッダー：Cache-Control |
| 404 | プロジェクト外のスクリーンは not_found、リンクのないスクリーンは screen_link_not_found。 | 問題 (application/problem+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) |
画面リンクを作成
スクリーンのリンクを発行して url を返します。スクリーンに既にあるリンクは置き換えられます（replaced で分かります）。スクリーンはアクティブで、コードで一度ペアリング済みである必要があります（ペアリング済み Player がない間は resource_conflict、アーカイブ済みなら screen_archived）。
置き換えるとスクリーンの content_access_generation が増え、公開 ID のローテーションと同様に有効な許可が再発行されるため、古いリンクが開いたセッションはすべて直ちに終了します。キーに紐付いたスクリーンの Player は自動で新しいセッションを発行します。最初のリンクでは何も増えません。リンクはデバイスバインディングではなく、スクリーンのキーには触れません。
screen.link_changed を追加します（details.action は created または replaced）。If-Match は任意です。url は認証情報です。1か所だけで開いてください。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/screens/RESOURCE_ID/link'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンの新しいリンク。 | ScreenLink（application/json）；ヘッダー：ETag、Cache-Control |
| 409 | resource_conflict（ペアリング済み Player がまだない）または screen_archived。 | 問題 (application/problem+json) |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+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) |
画面リンクを削除
スクリーンのリンクをオフにします。古い url は直ちに動作しなくなり、それが開いたセッションはすべて、置き換えのときと同様に終了します。スクリーンにリンクがない場合は、何も変更せずに成功します。リンクが存在した場合は screen.link_changed（details.action は deleted）を追加します。If-Match は任意です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/screens/RESOURCE_ID/link'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | 削除済み、または元からありません。 | 本文なし |
| 412 | revision_conflict。 | 問題 (application/problem+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) |
スクリーン回復を確認
保留中スクリーン回復を確認。ホストduidまたはシリアルが正確に1つのプロジェクトの1つのスクリーンと一致し、異なるバインド済み公開鍵でネイティブペアリング開始が行われた場合、そのスクリーンにオファーを記録（Screen.recovery_pending、プロジェクトイベント screen.recovery_offered）。
ホストオブジェクトはヒントであり認証情報ではありません。所有プロジェクトがこのルートを呼ぶまで何も再バインドされません。DUIDはパネル上の任意のアプリケーションで読み取れるため、オファーはフィッシングの対象になります。
生存確認（過去10分以内にキーが生存を示した場合はオファーなし）、1時間あたり3回のオファー制限、同一プロジェクト確認で軽減されます。recovery_pending.hostとイベントはオファー元デバイスのプラットフォーム、モデル、ファームウェア、製造元を含み、運営者が目の前のディスプレイと比較して確認できます。
確認は既存スクリーンへの保留中ネイティブペアリングを完了：ペアリングデバイスは通常通り pairing.claimed を受け取り、pairing.complete で保有を証明、新しいキーがスクリーンIDとなり、前のキーは15分の猶予期間付きで引退、その間ランタイムセッションは継続し発行も可能、その後拒否される。
プレイリスト、ラベル、タイムゾーン、スケジュール、履歴が保持されます。同じプロジェクトのみ；別のプロジェクトのスクリーンはnot_foundになります。If-Matchはオプションです。screen.recoveredを発行します。保留中がない場合はrecovery_not_offered、ペアリングセッションが期限切れの場合はrecovery_expired、識別子が複数の場所に付与されている場合はrecovery_ambiguousを発行します。
問題応答はデバイス識別子を決してエコーしません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。キーの作成または上書き時は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/recovery/confirm'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンはペアリングデバイスのキーに復元されました。レスポンスには現在のETagが含まれます。 | スクリーン（application/json） |
| 401 | 安定した 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) |
| 410 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 412 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンを置き換え
プロジェクト内の別のスクリーンとしてペアリングされているデバイスをこのスクリーンに移し、そのスクリーンをアーカイブします。これにより、このスクリーンは名前、タグ、タイムゾーン、プレイリスト、スケジュール、テイクオーバー、ディスプレイスケジュールとオーバーライド、ビデオウォール、コメント、履歴を新しいハードウェアでも保持します。
デバイスの公開鍵（またはブラウザーの資格情報）は今後このスクリーンを開きます。このスクリーンは置き換え側のホストと Player を引き継ぎ、ヘルス、ステータス、ストレージ、オブザベーション、キューに入っているコマンドはリセットされます。このスクリーンが持っていた鍵は、復旧の猶予期間とともに失効します。15分間はまだミントできますが、その後は拒否されます（key_retired）。バインドは何も解除されません。
置き換えられたスクリーンは archive_reason が replaced でアーカイブされ、バインドもホストも保持しません。どちらのスクリーンも content_access_generation が進むため、どちらかが保持していたすべてのセッションが終了します。デバイスは、それまで使っていたスクリーン宛ての player.reload（details.reason は replaced、24時間有効）を受け取り、このスクリーンとして再びミントします。
両方のスクリーンが、ペアリング済みの Player を持つアクティブな状態である必要があります（pairing_pending のスクリーンや未ペアリングの置き換え先は resource_conflict、アーカイブ済みは screen_archived）。with にはプロジェクト内の別のスクリーンを指定します（そうでなければ invalid_request。別のプロジェクトのスクリーンは not_found）。ビデオウォールを持つスクリーンには、display.wall を宣言した置き換え用の Player が必要です（wall_unsupported）。
If-Match は省略可能で、このスクリーンのリビジョンを確認します。プロジェクトイベント screen.replaced（details.from_screen_id）を発行し、screen.archived は発行しません。同じ Idempotency-Key での正確な再試行は、24時間、同じ応答を返します。
スクリーンに限定された呼び出し元（docs/screen-scope.md）には、スコープ内のスクリーンと with が必要です（outside_screen_scope。何もアーカイブされません）。どちらかのスクリーンが保護されている場合の置き換えは protected_target です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。キーの作成または上書き時は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| with（必須、文字列） | 同じプロジェクト内で、そのペアリング済みデバイスがパス内のスクリーンを引き継ぐスクリーンの ID。ペアリング済みの Player を持つ別のアクティブなスクリーンでなければならず、archive_reason が replaced でアーカイブされます。minLength: 1 maxLength: 256 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/replace'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | デバイスは今後このスクリーンを開きます。レスポンスは、新しいリビジョンと現在の ETag を持つこのスクリーンです。 | スクリーン（application/json） |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | resource_conflict、screen_archived、wall_unsupported。または、どちらかのスクリーンが保護されたスクリーンフォルダー内にある場合は protected_target。 | 問題 (application/problem+json) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
画面をアーカイブ
画面を既定の一覧から非表示にし、実際の画面に「画面はアーカイブ済み」ステータスを表示します。プレーヤーの公開鍵の紐付けは解除しません。screen_count の割り当てを解放します。画面のキュー内の reboot、clear_cache、restart_app、update コマンドをキャンセルします。キュー内の reload は引き続き配信されます。保護された画面フォルダー内の画面は protected_target (409) になります。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/archive'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンをアーカイブしました。 | スクリーン（application/json） |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 412 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンのアーカイブ解除
アーカイブ済みスクリーンをデフォルトリストに復元し、通常のマニフェストを再発行します。スクリーン承認を通過する必要があります。バウンドされた公開鍵は変更しません。
マニフェストが再発行され、スクリーンのplaylistは割り当てと同様にチェックされます。欠落または準備できていないコンテンツを参照するplaylistはresource_conflictでplaylist名を返し、playlistが修正されるまでスクリーンはアーカイブされたままです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/unarchive'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンをアンアーカイブしました。 | スクリーン（application/json） |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 413 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンを再読み込み
指定したアクティブまたはアーカイブ済みのスクリーンの Player に再読み込みを依頼します（docs/player-compatibility.md §6.3）。任意の本文で expires_in_s を設定でき、再読み込みが実行可能な期間を指定します（60〜86400秒、デフォルト86400、24時間）。範囲外の値は expires_in_s を示す invalid_request になります。
オンラインのスクリーンには、永続的なスクリーン単位の player.reload イベントが即座に送信され（details.reason は project、新しい reload_id、spread_s は 0、expires_at）、再読み込みは Screen.commands に sent として記録されます。
オフラインのスクリーンは、再読み込みをイベントなしで queued のまま保持します。expires_at より前にバックエンドがスクリーンの次のオンライン遷移を適用すると、同じ reload_id と expires_at でイベントが追加され、コマンドは sent になります。より新しい再読み込みは、queued のままの古い再読み込みを置き換えます。
expires_at を過ぎた queued の再読み込みは expired と表示され、POST /api/screens/{id}/commands/{command_id}/cancel で queued のままのものをキャンセルできます。ランタイム SSE ストリームは、このイベントをすべてのランタイムセッションに中継します。Player は、直前に実行した再読み込みから10分以内の再読み込みを無視します。
Web Player は次のページ境界で再読み込みし、ネイティブ Player は再生成・マニフェストの再取得・アップデート確認を行います。スクリーンのリビジョンは変わりません。If-Match と Idempotency-Key は、アーカイブと同様に省略可能です。同じ Idempotency-Key での正確な再試行は、24時間、元の本文を返します。
pairing_pending のスクリーンにはまだ Player がなく、resource_conflict を返します。スクリーンメッセージは、1クレジットの API メーターの対象外です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| expires_in_s（任意、整数） | コマンドが実行可能な期間（リクエストからの秒数）。queued のコマンドは期限が切れる前にのみ送信されます。Player は expires_at を過ぎたコマンドを無視します。デフォルト: 86400 最小値: 60 最大値: 86400 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/reload'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。state は、再読み込みがオンラインのスクリーンの Player に送られた場合は sent、スクリーンがオンラインになるのを待っている場合は queued です。再読み込みは expires_at まで実行可能です。ETag は変更されていないスクリーンのリビジョンです。 | ScreenReloadAccepted（application/json）；ヘッダー：Cache-Control、ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンプレイリストスケジュールを取得
スクリーンのサーバー評価済みプレイリストスケジュールを返します：優先順のエントリー（スクリーンにない場合は空）、updated_at、および現在生成しているeffective_playlist。ETagはスクリーンのリビジョンです。pairing_pending、アクティブ、およびアーカイブされたスクリーンは読み取り可能です。別のプロジェクトのスクリーンはnot_foundです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/playlist-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | プレイリストのスケジュール。 | スクリーンプレイリストスケジュールビュー（application/json）；ヘッダー：ETag |
| 401 | 安定した 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) |
| 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) |
スクリーンプレイリストスケジュールを設定
スクリーンのプレイリストスケジュールを置き換えます。サーバーが評価し、Playerは評価しません。スクリーンの標準時間（screenrig.schedule/v1ウィンドウとfrom/until、タイムゾーン内、夏時間や日跨ぎウィンドウ含む）に合致する最初のエントリーが有効なプレイリストです。合致しない場合は割り当てられたplaylist_idが有効です。
テイクオーバーはすべてのエントリに勝ちます。スクリーンはタイムゾーンと割り当てられたデフォルトの playlist_id を持つ必要があります（そうでなければ invalid_request）。常にフォールバックがあります。
参照されたすべてのプレイリストは割り当てと同様にスクリーンに対して正確に検証されます（所有、準備済み参照、ページの可視性にはタイムゾーンが必要、フォーマット付きプレイリストは壁の形状が同じスクリーンが必要、そうでなければ409 playlist_format_mismatch）。スクリーンが拒否するプレイリストはここでも拒否されます。チェックはプレイリスト文書を書き込むため、同時のプレイリスト削除は競合します。
スケジュールされたプレイリストが後で表示できなくなった場合（例：コンテンツが解決できない）、評価時にそのエントリはスキップされ、screen.playlist_unavailable（警告、詳細：playlist_id、entry_ids、code）が追加されます。
実際のプレイリストが変更されると、マニフェストが再生成され、Playerにscreen.manifest_changedが割り当てられ、screen.playlist_switchedが追加されます。画面のリビジョンが更新され（If-Matchで保護）、screen.updatedにdetails.playlist_schedule_entriesが追加されます。
アーカイブされたスクリーンは screen_archived を返します。スケジュール、テイクオーバー、デフォルトは参照されたままで（プレイリスト削除をブロック）、アンアーカイブ時に再解決されます。レート制限: screen-control-org 600、screen-control-screen 20、screen-control-ip 60／分。DELETE とテイクオーバールートと共有。
保護されたスクリーンでは、スケジュールは、すべてのアクセスレベルで、2人目の承認者が決定するレビューになります（202 pending_review）。paused が true の新しいエントリ（下書き）はスケジュールの変更管理であり、Enterprise プランに含まれます。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。
すでに保存されているエントリは一時停止のままにでき、保存済みのエントリの一時停止はすべてのプランで利用できます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| エントリー（必須、配列） | 優先順位順：最初に一致したエントリが勝ちます。DELETEでスケジュールをクリアします。 |
リクエストテンプレートとレスポンス
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/playlist-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みは Propose access の下でレビューとなり、承認待ちになります（docs/reviews.md）。Idempotency-Key の再生は同じ内容で応答します。 | ReviewPending（application/json）；ヘッダー：RateLimit-Policy、RateLimit |
| 200 | 保存されたスケジュールとそのeffective_playlistを持つスクリーン。ETagは新しいリビジョンです。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 402 | feature_not_in_plan — スケジュールの変更管理は Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。スクリーンの保存済みエントリ以外で、プレイリストをビデオウォールのディスプレイ 2 以降（displays）にロックするエントリは Plus に含まれます。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (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 と同じです。スケジュールのないスクリーンには、変更なしで 200 が返されます（リビジョンの更新もイベントもありません）。
保護されたスクリーンでは、スケジュールの解除は、すべてのアクセスレベルで、2人目の承認者が決定するレビューになります（202 pending_review）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/playlist-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みは Propose access の下でレビューとなり、承認待ちになります（docs/reviews.md）。Idempotency-Key の再生は同じ内容で応答します。 | ReviewPending（application/json）；ヘッダー：RateLimit-Policy、RateLimit |
| 200 | プレイリストスケジュールなしのスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンプレイリストスケジュールのプレビュー
スクリーンのプレイリストスケジュールを entries で置き換えた場合に変わる内容を、置き換えずに返します。
entries は PUT と同じ方法で検査されます (文法、スクリーンのタイムゾーンとディスプレイ、デフォルトプレイリスト、割り当てとしての各プレイリスト: 存在すること、承認済みバージョンがあること、スクリーンのウォールとそれが担当するリージョンに合うこと、参照が解決できること)。そのため、プレビューは PUT が拒否するものを拒否します。
応答には、スクリーンのスタック上でスケジュールのレベルが加わるか失われるか (一時停止中のエントリーはどのスタックにも載らないため、公開すると加わります)、およびスクリーンのスケジュールカレンダーが、from から to まで (デフォルト: 現在から 1 週間。最大 93 日) の現状 (before) と変更後 (after) の両方で含まれます。読み取りアクセス: 何も書き込まれません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| エントリー（必須、配列） | |
| from（任意、string） | カレンダーの開始。デフォルトは現在です。format: "date-time" |
| to（任意、文字列） | カレンダーの終了。デフォルトは from の 1 週間後で、最大で from の 93 日後までです。format: "date-time" |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/playlist-schedule/preview'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | プレビュー。 | SchedulePreview（application/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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンプレイリストスケジュールのリビジョン一覧
スクリーンのプレイリストスケジュールのリビジョン (新しい順): 書き込み (PUT、DELETE、復元、スケジュールインポート) のたびに保存された entries リスト全体で、変更の種類と変更者が含まれます。リビジョンには書き込み時のスクリーンのリビジョンが番号として付くため、スクリーンが別の形で変更された箇所では番号に欠番があります。
履歴にまだ行がないスクリーンは、現在のスケジュールを change baseline として一覧表示します。リビジョンはスクリーンの削除とともに消えます。1 ページあたり最大 50 件。続きがある間は next_cursor が返り、最後のページでは null です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| 以降 | クエリ | オプション | 同じリストの前のページの next_cursor。同じフィルター付き。省略時は最新行から開始。カーソルでない値は invalid_request。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/screens/RESOURCE_ID/playlist-schedule/revisions'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンのスケジュールのリビジョン (新しい順)。 | ScreenScheduleRevisionList（application/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) |
スクリーンプレイリストスケジュールのリビジョンを復元
以前のリビジョンの entries をスクリーンのスケジュールとして元に戻します: それらの entries を指定した PUT /api/screens/{id}/playlist-schedule (そのリビジョンに entries がなかった場合は DELETE) と同じ書き込みで、現在と同じ検査が行われます (その後に削除されたプレイリストがあると拒否されます)。そのため、Propose アクセスでは、復元は PUT がなるものと同じ screen_change レビューになります。
If-Match は必須で、スクリーンの現在のリビジョンを指定します。以前のリビジョンはそのまま残ります。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| リビジョン | パス | 必須 | レコードのリビジョン（リビジョン一覧が付ける番号）。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/screens/RESOURCE_ID/playlist-schedule/revisions/REVISION/restore'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みは Propose access の下でレビューとなり、承認待ちになります（docs/reviews.md）。Idempotency-Key の再生は同じ内容で応答します。 | ReviewPending（application/json）；ヘッダー：RateLimit-Policy、RateLimit |
| 200 | 復元されたスケジュールとその effective_playlist を持つスクリーン。ETag は新しいリビジョンです。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンテイクオーバーを設定
キャンペーン、スクリーンのプレイリストスケジュール、割り当て済みのプレイリストよりも優先して、1つのプレイリストでスクリーンをテイクオーバーします。until（RFC 3339。現在より後で、最大7日先まで）まで、または until が null か省略された場合はテイクオーバーが解除されるまで続きます。reason は任意で、最大120文字です。
スクリーンには、割り当て済みのデフォルトの playlist_id が必要です（ない場合は invalid_request）。テイクオーバーは以前のものを置き換えます（reason が replaced の screen.takeover_ended。以前のものがすでに終了していた場合は expired）。
プレイリストは、フォーマットも含めて、割り当てとして検証されます（フォーマットを持つプレイリストには、同じ形状のウォールを持つスクリーンが必要で、そうでない場合は 409 playlist_format_mismatch）。プレイリストが後から表示できなくなったテイクオーバーは終了します（reason が playlist_deleted または playlist_unavailable の screen.takeover_ended）。
screen.takeover_started を追加し、有効なプレイリストが変わる場合は、screen.playlist_switched とプレーヤー向けの screen.manifest_changed も追加します。until を過ぎると、境界ワーカーが60秒以内にテイクオーバーを終了します（reason が expired の screen.takeover_ended）。スクリーンのリビジョンが更新されます（If-Match で保護されます）。
アーカイブ済みのスクリーンは screen_archived を返します。アーカイブ解除ではまず再解決が行われるため、アーカイブ中に終了したテイクオーバーはその時点で終了します。スケジュールのルートと同じスクリーン制御のレート制限が適用されます。保護されたスクリーンでは、テイクオーバーは、すべてのアクセスレベルで、2人目の承認者が決定するレビューになります（202 pending_review）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| playlist_id（必須、文字列） | minLength: 1 |
| まで（オプション、インライン） | 厳密に未来で最大7日先まで。null または省略はクリアされるまでテイクオーバーを保持。 |
| 理由（任意、文字列） | テイクオーバーとそのイベントに付随するオペレーターノート。制御文字なし。maxLength：120 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/takeover'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みは Propose access の下でレビューとなり、承認待ちになります（docs/reviews.md）。Idempotency-Key の再生は同じ内容で応答します。 | ReviewPending（application/json）；ヘッダー：RateLimit-Policy、RateLimit |
| 200 | テイクオーバーとそのeffective_playlistを持つスクリーン。ETagは新しいリビジョンです。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンテイクオーバーをクリア
テイクオーバーを終了します（screen.takeover_ended、理由はcleared）。スケジュールまたは割り当てられたプレイリストが同じマニフェスト信号で有効になります。テイクオーバーがないスクリーンは200で変更なしを返します（リビジョン更新なし、イベントなし）。
アーカイブ済み画面の割り込み表示も解除されます。画面はアーカイブされたままで、Player に通知は送られず、アーカイブ解除時に有効なプレイリストが決定されます。保護された画面では、アクセスレベルにかかわらず、割り込み表示の解除には承認権限を持つ別の人によるレビューが必要です (202 pending_review)。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8（JavaScriptのencodeURIComponentが書くもの）です。サーバーはパーセントデコードします（無効なエスケープは400 invalid_request）。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし（そうでなければ400 invalid_request）。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/takeover'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みは Propose access の下でレビューとなり、承認待ちになります（docs/reviews.md）。Idempotency-Key の再生は同じ内容で応答します。 | ReviewPending（application/json）；ヘッダー：RateLimit-Policy、RateLimit |
| 200 | テイクオーバーなしのスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
タブ共有を開始
スクリーンにブラウザータブを表示します。タブごとに1920x1080のキャンバス全体を使うiframeページからなる一時プレイリストを作り、すべての対象をそのプレイリストに切り替えます（理由「Shared browser tab」）。終了はuntilで、最大24時間後（既定）です。
対象はscreen_ids、folder_idsおよびその内部のフォルダー内の全アクティブスクリーン、tagsのいずれかを持つ全アクティブスクリーンの和集合です。オフラインのスクリーンも含み、復帰時に共有を表示します。
スクリーンに範囲が制限された呼び出し元（docs/screen-scope.md）は範囲内のスクリーンだけを操作できます。範囲外はスキップされます（outside_screen_scope）。リクエストのほかの処理規則は同じです。
タブが1つなら共有終了まで表示し、複数なら各タブのduration_s後に進みます。reload_sは各ページを再読み込みします。qrはページアドレスのQRコードを右下にキャンバス高の約14%の大きさで追加します。cookiesは送信者のページへのログイン情報です。保存時は封印され、読み取り、イベント、監査記録、リビジョンには返されず、共有を表示するスクリーンの実行時マニフェストだけで渡されます（iframeのcookiesメンバー）。設定できないPlayerは無視し、Web Playerとそれに委譲するシェルも無視します。
切り替えられない対象（保護フォルダー、既定プレイリストなし、アーカイブ済み、未検出、形式不一致、範囲外、レート制限）はskippedに記載され、リクエスト全体は失敗しません。以前の共有を表示中のスクリーンは今回の共有に切り替わり、以前のプレイリストは表示するスクリーンがなくなると削除されます。
対象を1台も切り替えられない場合、一時プレイリストを削除し、単独対象の問題または理由を示す409 resource_conflictを返します。warningsはバックエンドが埋め込めなかったタブアドレスを列挙します（embedding_blocked：X-Frame-Optionsまたはframe-ancestorsがPlayer Webアプリを拒否）。アドレスごとに1回、3秒の予算で確認し、共有はブロックしません。
スクリーン制御のレート制限は対象スクリーンごと（組織とスクリーン）に、IP制限はリクエストごとに1回適用されます。呼び出しごとに新規共有となり、Idempotency-Keyは再実行を提供しません。変更は即時で、Proposeアクセスではinsufficient_access、ダッシュボード経路でレビューを承認できないメンバーにはapprover_requiredで拒否します。
ダッシュボード経路ではセッションの現在のプロジェクトを使用します（未選択ならno_project）。ダッシュボードまたはChromeやFirefox拡張機能のオリジン（chrome-extension://ID、moz-extension://UUID）から要求でき、Sec-Fetch-Siteは未指定、same-origin、noneのいずれかです。X-ScreenRig-CSRFヘッダーがある場合はGET /api/sessionのcsrf_tokenと一致する必要があります。
拡張機能のオリジンを受け付けるのは、このルート、DELETE /api/tab-shares/{id}、POST /api/playlists/{id}/pages、POST /api/screens/{id}/screenshotだけです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| screen_ids（任意、array） | idで指定するスクリーン。重複はまとめられます。 |
| folder_ids（任意、配列） | スクリーンフォルダー。各フォルダーは内部のすべてのフォルダーを含みます。 |
| tags（任意、array） | いずれかのタグを持つスクリーン。 |
| tabs（必須、array） | |
| cookies（任意、array） | 送信者のページ用Cookie。エンコード後最大64 KiBの秘密情報です。POST /api/tab-sharesを参照。 |
| reload_s（任意、integer） | 0（再読み込みなし、既定）または60〜86400：各ページのiframeを再読み込みする間隔。 |
| until（任意、string） | 現在より後、かつ24時間以内。省略時は現在から24時間後です。各対象の切り替え終了時刻と一時プレイリストの有効期限。format: "date-time" |
| qr（任意、boolean） | trueなら各ページの右下にアドレスのQRコードを表示します。既定はfalseです。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/tab-shares'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 共有。少なくとも1台のスクリーンを切り替えました。 | TabShare (application/json）；ヘッダー：RateLimit-Policy, RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
タブ共有を取得
共有の終了時刻と、まだ共有のプレイリストに切り替わっているスクリーンを読み取ります。その後別の操作で切り替えられたものやアーカイブ済みのものは含みません。共有が終了、期限切れ、または存在しなかった場合は404 not_foundです。範囲が制限された呼び出し元には範囲内だけを表示します。読み取りには拡張機能のオリジン規則は適用されません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/tab-shares/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 共有と、それをまだ表示しているスクリーン。 | TabShareState (application/json) |
| 401 | 安定した 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) |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
タブ共有を停止
共有を終了します。切り替え先がまだ共有のプレイリストであるすべてのスクリーンを解除し（理由clearedのscreen.takeover_endedを発行し、同じマニフェスト通知でスケジュール、なければ割り当てたプレイリストを有効化）、プレイリストを削除します。保護フォルダー内のスクリーンでも許可されます。
その後ほかの操作で切り替えられたスクリーンは変更しません。共有が終了済みなら404 not_foundとなり、クライアントは終了として扱います。リクエストごとに各スクリーン制御制限を1単位消費します。範囲が制限された呼び出し元は範囲内だけを解除できます。経路、アクセス規則、拡張機能のオリジン規則はPOST /api/tab-sharesと同じです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/tab-shares/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 切り替えを解除したスクリーン。 | TabShareStopped (application/json）；ヘッダー：RateLimit-Policy, RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンページを再生
スクリーンの Player に現在再生中のプレイリストの1ページを開始するよう依頼。次のスクリーンショットが回転待ちなしでそのページを表示（docs/player-compatibility.md §6.3.1）。
ページは、スクリーンの有効なプレイリスト（マニフェストの元になるプレイリスト）のページである必要があります。優先順は、実行中のテイクオーバー、次に適用中のキャンペーン、次に現在のプレイリストスケジュールのエントリ、最後に割り当て済みのプレイリストです。そうでない場合は 409 page_not_on_screen となり、その detail にそのプレイリストが示されます。
スクリーンのホストヒントはplay_page機能を宣言しなければならず、そうでなければ409 play_page_unsupportedで何も送信されません。プレーヤーを更新してください。スクリーンはアクティブでなければなりません。アーカイブされたスクリーンはscreen_archivedを返し、pairing_pendingはresource_conflictを返します。
画面ごとのランタイムコマンド player.play_page を追加します（詳細は page_id、playlist_id、manifest_revision、expires_at は60秒後；expires_at 後は配信されません）。Player はローテーションが到達したかのようにページの最初から再生を開始し、そこからローテーションを続けます。画面のリビジョンは変わりません。
Idempotency-Key は toast と同様に必須です。正確な再試行は、元の本文を24時間返します。拒否されたリクエスト、失敗したリクエスト、正確なリプレイは、レート制限の予算を消費しません。スクリーンメッセージは、1クレジットの API メーターの対象外です。保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| page_id（必須、文字列） | スクリーンが現在再生しているプレイリストのページID（そのプレイリストのページ内のID）。minLength：1 maxLength：128 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/play-page'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。コマンドはexpires_atまで実行可能です。完全な冪等リトライは同じ本文を返します。 | スクリーンページ再生承認（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンを識別
スクリーンの Player に、duration_ms（2000〜600000、デフォルト60000）の間、コンテンツの上にスクリーン名を表示するよう依頼します。複数のディスプレイの前にいる人が、どのディスプレイがどのレコードに対応するかを見分けられます（docs/player-compatibility.md §6.3.2）。
スクリーン単位のランタイムコマンド player.identify を追加します（details は identify_id、label、screen_id、duration_ms、at、at の60秒後の expires_at。expires_at を過ぎると配信されません）。
Player はコンテンツの上に全画面のオーバーレイを描画し、名前を非常に大きく、その下にスクリーン ID を小さく表示します。表示は受信から duration_ms の間続きます。再生はその下で続き、より新しい identify コマンドがオーバーレイを置き換えます。
スクリーンのホストヒントは identify 機能を宣言している必要があります。宣言していなければ 409 identify_unsupported となり、何も送信されません。Player を更新するか、トーストで名前を表示してください。スクリーンはアクティブでなければなりません。アーカイブ済みのスクリーンは screen_archived を、pairing_pending のスクリーンは resource_conflict を返します。スクリーンのリビジョンは変わりません。
本文と Idempotency-Key は省略可能です。正確な再試行は、24時間、元の本文を返します。拒否されたリクエスト、失敗したリクエスト、正確なリプレイは、レート制限の枠を消費しません。スクリーンメッセージは、1クレジットの API メーターの対象外です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| duration_ms（任意、整数） | オーバーレイが表示され続ける時間（Player が受信してからのミリ秒）。省略時は60000です。デフォルト: 60000 最小値: 2000 最大値: 600000 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/identify'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。コマンドはexpires_atまで実行可能です。完全な冪等リトライは同じ本文を返します。 | ScreenIdentifyAccepted（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンを一時停止
スクリーンを一時停止します。Player はコンテンツの代わりに message を表示します（docs/player-compatibility.md §6.9）。message はトリム後に1〜280文字で、使用できる制御文字は改行のみです。
それ以外は何も変わりません。プレイリスト、スケジュール、テイクオーバー、ディスプレイ制御、その他のすべての設定はそのまま残り、変化し続け、再開するとスクリーンが現在表示するはずの内容が表示されます。Screen.suspension には message と since が含まれます。一時停止中のスクリーンをさらに一時停止すると、message が置き換わり、since は維持されます。
一時停止中のスクリーンのランタイムマニフェストでは、pages が []、suspension メンバーがあり、プレイリストが割り当てられているかどうかにかかわらず、固有のマニフェストリビジョンを持ちます。Player には直ちに再取得するよう通知されます。プロジェクト専用の screen.suspended（details は message）を追加します。アーカイブ済みのスクリーンは screen_archived を返します。If-Match と Idempotency-Key は、アーカイブと同様に省略可能です。
保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| message（必須、文字列） | スクリーンに表示する通知で、トリム後に1〜280文字です。使用できる制御文字は改行のみです。Player はテキストを折り返し、改行を保持します。minLength: 1 maxLength: 280 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/suspend'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンが一時停止されました。ETag は新しいスクリーンのリビジョンです。 | スクリーン（application/json）；ヘッダー：ETag |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 412 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンを再開
スクリーンの一時停止を終了します。Player は、現在そのスクリーンに配信されるマニフェストから、スクリーン自身のコンテンツを再び表示します（docs/player-compatibility.md §6.9）。Player には直ちに再取得するよう通知されます。プロジェクト専用の screen.resumed を追加します。一時停止していないスクリーンを再開した場合は、スクリーンを変更せずに 200 を返し、リビジョンの更新もイベントもありません。
アーカイブ済みのスクリーンは screen_archived を返します。本文はありません。If-Match と Idempotency-Key は、アーカイブと同様に省略可能です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/resume'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンが再開されたか、一時停止していませんでした。ETag はスクリーンのリビジョンです。 | スクリーン（application/json）；ヘッダー：ETag |
| 401 | 安定した 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) |
| 412 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンを再起動
スクリーンの Player にデバイスの再起動を依頼します（docs/player-compatibility.md §6.5）。任意の本文で expires_in_s を設定でき、再起動が実行可能な期間を指定します（60〜86400秒、デフォルト86400、24時間）。範囲外の値は expires_in_s を示す invalid_request になります。プロジェクト専用の screen.reboot_requested を必ず追加します。
オンラインのスクリーンには、スクリーン単位のランタイムコマンド player.reboot が即座に送信され（details は reboot_id、reason は project、at、expires_at。expires_at を過ぎると配信されません）、再起動は Screen.commands に sent として記録されます。
オフラインのスクリーンは、再起動をイベントなしで queued のまま保持します。expires_at より前にバックエンドがスクリーンの次のオンライン遷移を適用すると、同じ reboot_id と expires_at でイベントが追加され、コマンドは sent になります。uptime_s を含むヘルスレポートが、起動が送信より後であることを示すと、sent の再起動は done になります。
より新しい再起動は、queued のままの古い再起動を置き換えます。expires_at を過ぎた queued の再起動は expired と表示され、POST /api/screens/{id}/commands/{command_id}/cancel で queued のままのものをキャンセルできます。スクリーンはアクティブでなければなりません。アーカイブ済みのスクリーンは screen_archived を、pairing_pending のスクリーンは resource_conflict を返します。
スクリーンのホストヒントは reboot 機能を宣言している必要があります。宣言していなければ 409 reboot_unsupported となり、何も記録されません。スクリーンのリビジョンは変わりません。If-Match と Idempotency-Key は省略可能です。正確な再試行は、24時間、同じ本文を返します。
スクリーンごとに10分あたり最大2回です。拒否されたリクエスト（reboot_unsupported、not_found、競合）、失敗したリクエスト、同じ Idempotency-Key での正確なリプレイは、回数を消費しません。
再起動が送信されてから、ヘルスレポートで完了が確認されるか10分が経過するまで、スクリーンは screen_offline、display_disconnected、crashing の通知やアラートを発生させません。その時点で条件が続いていれば通常どおり発生します。再起動スケジュール（PUT /api/screens/{id}/reboot-schedule）は source schedule で同じ再起動を発行します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| expires_in_s（任意、整数） | コマンドが実行可能な期間（リクエストからの秒数）。queued のコマンドは期限が切れる前にのみ送信されます。Player は expires_at を過ぎたコマンドを無視します。デフォルト: 86400 最小値: 60 最大値: 86400 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/reboot'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。state は、再起動がオンラインのスクリーンの Player に送られた場合は sent、スクリーンがオンラインになるのを待っている場合は queued です。再起動は expires_at まで実行可能です。ETag は変更されていないスクリーンのリビジョンです。 | スクリーン再起動承認（application/json）；ヘッダー：Cache-Control、ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンのキャッシュをクリア
スクリーンの Player にキャッシュのクリアを依頼します（docs/player-compatibility.md §6.5.1）。Player はダウンロード済みのメディア、アプリケーションパッケージ、データキャッシュを削除し、ペアリング、ID、設定は保持したまま、マニフェストとコンテンツを再び取得します。
任意の本文で expires_in_s を設定でき、コマンドが実行可能な期間を指定します（60〜86400秒、デフォルト86400、24時間）。範囲外の値は expires_in_s を示す invalid_request になります。プロジェクト専用の screen.command_requested を必ず追加します。
オンラインのスクリーンには、スクリーンごとのランタイムコマンド player.clear_cache が直ちに送信され（details は command_id, command, reason project, at, expires_at。expires_at を過ぎて配信されることはありません）、コマンドは Screen.commands に sent として記録されます。
オフラインのスクリーンは、コマンドをイベントなしで queued として保持します。expires_at より前にバックエンドがスクリーンの次のオンライン遷移を適用すると、同じ command_id と expires_at でイベントが追加され、コマンドは sent になります。
Player が終了状態を報告します。コマンドは Screen.commands で、Player が報告した原因（cause、detail）とともに done または failed になり、プロジェクト専用の screen.command_result が追加されます。報告のない sent のコマンドは sent のままです。
同じ種類のより新しいコマンドは、まだ queued のコマンドを置き換え、POST /api/screens/{id}/commands/{command_id}/cancel はまだ queued のコマンドをキャンセルします。スクリーンはアクティブである必要があります。アーカイブ済みのスクリーンは screen_archived を、pairing_pending のスクリーンは resource_conflict を返します。
スクリーンのホストヒントは clear_cache 機能を宣言している必要があります。宣言していない場合は 409 command_unsupported となり、何も記録されません。スクリーンのリビジョンは変わりません。If-Match と Idempotency-Key は任意です。完全に同じ再試行は24時間同じ本文を返します。
clear-cache、restart-app、update を合わせて、スクリーンごとに10分間に最大2回です。拒否されたリクエスト（command_unsupported、not_found、競合）、失敗したリクエスト、完全に同じ Idempotency-Key のリプレイは回数を消費しません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| expires_in_s（任意、整数） | コマンドが実行可能な期間（リクエストからの秒数）。queued のコマンドは期限が切れる前にのみ送信されます。Player は expires_at を過ぎたコマンドを無視します。デフォルト: 86400 最小値: 60 最大値: 86400 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/clear-cache'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。state は、コマンドがオンラインのスクリーンの Player に送られた場合は sent、スクリーンがオンラインになるまで待機している場合は queued です。コマンドは expires_at まで実行可能です。ETag は変更されていないスクリーンのリビジョンです。 | ScreenMaintenanceAccepted（application/json）；ヘッダー：Cache-Control、ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンのアプリを再起動
スクリーンの Player にアプリケーションの再起動を依頼します。デバイスは再起動しません（docs/player-compatibility.md §6.5.1）。Player プロセスが再起動し、新しいプロセスから報告します。任意の本文で expires_in_s を設定でき、コマンドが実行可能な期間を指定します（60〜86400秒、デフォルト86400、24時間）。範囲外の値は expires_in_s を示す invalid_request になります。
プロジェクト専用の screen.command_requested を必ず追加します。オンラインのスクリーンには、スクリーンごとのランタイムコマンド player.restart_app が直ちに送信され（details は command_id, command, reason project, at, expires_at。expires_at を過ぎて配信されることはありません）、コマンドは Screen.commands に sent として記録されます。
オフラインのスクリーンは、コマンドをイベントなしで queued として保持します。expires_at より前にバックエンドがスクリーンの次のオンライン遷移を適用すると、同じ command_id と expires_at でイベントが追加され、コマンドは sent になります。
Player が終了状態を報告します。コマンドは Screen.commands で、Player が報告した原因（cause、detail）とともに done または failed になり、プロジェクト専用の screen.command_result が追加されます。報告のない sent のコマンドは sent のままです。
同じ種類のより新しいコマンドは、まだ queued のコマンドを置き換え、POST /api/screens/{id}/commands/{command_id}/cancel はまだ queued のコマンドをキャンセルします。スクリーンはアクティブである必要があります。アーカイブ済みのスクリーンは screen_archived を、pairing_pending のスクリーンは resource_conflict を返します。
スクリーンのホストヒントは restart_app 機能を宣言している必要があります。宣言していない場合は 409 command_unsupported となり、何も記録されません。スクリーンのリビジョンは変わりません。If-Match と Idempotency-Key は任意です。完全に同じ再試行は24時間同じ本文を返します。
clear-cache、restart-app、update を合わせて、スクリーンごとに10分間に最大2回です。拒否されたリクエスト（command_unsupported、not_found、競合）、失敗したリクエスト、完全に同じ Idempotency-Key のリプレイは回数を消費しません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| expires_in_s（任意、整数） | コマンドが実行可能な期間（リクエストからの秒数）。queued のコマンドは期限が切れる前にのみ送信されます。Player は expires_at を過ぎたコマンドを無視します。デフォルト: 86400 最小値: 60 最大値: 86400 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/restart-app'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。state は、コマンドがオンラインのスクリーンの Player に送られた場合は sent、スクリーンがオンラインになるまで待機している場合は queued です。コマンドは expires_at まで実行可能です。ETag は変更されていないスクリーンのリビジョンです。 | ScreenMaintenanceAccepted（application/json）；ヘッダー：Cache-Control、ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンの Player を更新
スクリーンの Player に、最新の Player リリースを今すぐ確認してインストールするよう依頼します（docs/player- compatibility.md §6.5.1）。結果の cause は、最新リリースがすでに動作している場合は up_to_date、リリースがインストールされた場合は updated です。ストア管理またはデバイス管理のインストールは、更新機能を宣言しません。
任意の本文で expires_in_s を設定でき、コマンドが実行可能な期間を指定します（60〜86400秒、デフォルト86400、24時間）。範囲外の値は expires_in_s を示す invalid_request になります。プロジェクト専用の screen.command_requested を必ず追加します。
オンラインのスクリーンには、スクリーンごとのランタイムコマンド player.update が直ちに送信され（details は command_id, command, reason project, at, expires_at。expires_at を過ぎて配信されることはありません）、コマンドは Screen.commands に sent として記録されます。
オフラインのスクリーンは、コマンドをイベントなしで queued として保持します。expires_at より前にバックエンドがスクリーンの次のオンライン遷移を適用すると、同じ command_id と expires_at でイベントが追加され、コマンドは sent になります。
Player が終了状態を報告します。コマンドは Screen.commands で、Player が報告した原因（cause、detail）とともに done または failed になり、プロジェクト専用の screen.command_result が追加されます。報告のない sent のコマンドは sent のままです。
同じ種類のより新しいコマンドは、まだ queued のコマンドを置き換え、POST /api/screens/{id}/commands/{command_id}/cancel はまだ queued のコマンドをキャンセルします。スクリーンはアクティブである必要があります。アーカイブ済みのスクリーンは screen_archived を、pairing_pending のスクリーンは resource_conflict を返します。
スクリーンのホストヒントは update 機能を宣言している必要があります。宣言していない場合は 409 command_unsupported となり、何も記録されません。スクリーンのリビジョンは変わりません。If-Match と Idempotency-Key は任意です。完全に同じ再試行は24時間同じ本文を返します。
clear-cache、restart-app、update を合わせて、スクリーンごとに10分間に最大2回です。拒否されたリクエスト（command_unsupported、not_found、競合）、失敗したリクエスト、完全に同じ Idempotency-Key のリプレイは回数を消費しません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| expires_in_s（任意、整数） | コマンドが実行可能な期間（リクエストからの秒数）。queued のコマンドは期限が切れる前にのみ送信されます。Player は expires_at を過ぎたコマンドを無視します。デフォルト: 86400 最小値: 60 最大値: 86400 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/update'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。state は、コマンドがオンラインのスクリーンの Player に送られた場合は sent、スクリーンがオンラインになるまで待機している場合は queued です。コマンドは expires_at まで実行可能です。ETag は変更されていないスクリーンのリビジョンです。 | ScreenMaintenanceAccepted（application/json）；ヘッダー：Cache-Control、ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンコマンドを一覧表示
有効またはアーカイブ済みのスクリーンに出されたすべての再起動と再読み込みを、新しい順に一覧表示します。Screen.commands が保持するコマンド（最新の10件）とそれより古いすべてのコマンドを、それぞれが到達した状態とともに返します。expires_at を過ぎたキュー内のコマンドは expired になります。スクリーンのデバイスが交換された時点でまだキューにあったコマンドは cancelled になります。
キューに残っているコマンドは POST /api/screens/{id}/commands/{command_id}/cancel でキャンセルします。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| カーソル | クエリ | オプション | 前のページの next_cursor。 |
| 制限 | クエリ | オプション |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/commands'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンのコマンドの1ページ分。 | ScreenCommandPage (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) |
スクリーンコマンドをキャンセル
スクリーンに対してまだ queued の再起動または再読み込みをキャンセルし、送信されないようにします（docs/player-compatibility.md §6.3, §6.5）。command_id は Screen.commands 内の id、または 202 応答の reboot_id もしくは reload_id です。キャンセルできるのは state が queued のコマンドだけで、キャンセルされると cancelled になります。
すでに送信されたコマンド（sent、done）は 409 resource_conflict と "The command was already sent." を返します。queued ではなくなったコマンド（expired、cancelled、superseded）は 409 resource_conflict と "The command is no longer queued." を返します。スクリーンの一覧にない ID は 404 not_found を返します。スクリーンの一覧には、最新の10件のコマンドが保持されます。
スクリーンのリビジョンは変わりません。If-Match と Idempotency-Key は省略可能です。正確な再試行は、24時間、同じスクリーンを返します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| command_id | パス | 必須 | スクリーンのコマンドの ID。Screen.commands 内の id、または 202 応答の reboot_id もしくは reload_id です。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/commands/COMMAND_ID/cancel'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | コマンドがキャンセルされたスクリーン。ETag は変更されていないスクリーンのリビジョンです。 | スクリーン（application/json）；ヘッダー：ETag |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンディスプレイを設定
表示のオンまたはオフを今すぐ要求します：表示スケジュールの手動オーバーライド（docs/player-compatibility.md §6.5）。powerはオンかオフ。until（RFC 3339、厳密に未来、最大7日先）で終了します。untilがない場合、スケジュールが有効なら次のスケジュール境界で終了し、そうでなければ置き換えられるまで保持します。
オーバーライド（Screen.display.override）を保存し、マニフェストを再発行します（その display メンバーはオフラインの Player が保持するためオーバーライドを含みます）。ランタイムコマンド player.display（詳細は override_id、power、until、at、expires_at）とプロジェクト専用 screen.display_changed を追加し、スクリーンリビジョンを更新します（If-Match で保護）。スクリーンはアクティブでなければなりません。
Player が達成したことは、そのヘルス display.power（Screen.display.reported）で報告されます。成功した場合、レポートを待たずに意図が保存されます。Screen.display.override_status はその後の観測結果を比較し、Screen.display.control は通知された制御方法を示します。
スクリムのみの Player は、オンのリクエストに対して、ハードウェアのウェイクコマンドなしでオーバーレイを解除します。
untilなしかつ次の8日間にスケジュール境界がない場合（有効なスケジュールなし、または変更なし）、オーバーライドはDELETE /api/screens/{id}/displayまたは置換まで有効です。後のdisplay-scheduleのPUTやDELETE、タイムゾーン変更はuntilなしオーバーライドを新しい次境界に再設定します。
拒否または失敗したリクエスト、および正確な Idempotency-Key のリプレイは、予算を消費しません。保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| 電源（必須、文字列） | 許可されている値: "on"、"off"。 |
| まで（オプション、インライン） | 厳密に未来、最大7日先まで。省略または null は表示スケジュールの次の境界まで、そうでなければ置き換えまで。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/display'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ディスプレイ状態を含むスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーン表示をクリア
手動表示オーバーライドを終了し、表示スケジュール（それ以外はオン）が再び適用されます。マニフェストを再発行し（displayメンバーがオーバーライドを解除し、Playerはscreen.manifest_changedに従います）、screen.display_changedにchange override_clearedを追加し、リビジョンを更新します。アクティブなオーバーライドがないスクリーンは200で変更なしを返します。
保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/display'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ディスプレイ状態を含むスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーン表示スケジュールを取得
display_schedule（ない場合はnull）とスクリーンの表示状態を返します。ETagはスクリーンのリビジョンです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/display-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 表示スケジュール。 | スクリーン表示スケジュールビュー（application/json）；ヘッダー：ETag |
| 401 | 安定した 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) |
| 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) |
スクリーンディスプレイスケジュールを設定
ディスプレイスケジュールを置き換えます。表示がONのとき、1～16個のscreenrig.schedule/v1ウィンドウ（曜日、開始/終了HH:MM、終了<=開始は翌日扱い、端なしの終日）を有効にします。ウィンドウ外ではPlayerがディスプレイをスタンバイにします。
スクリーンのタイムゾーンでデバイス上で評価されます（必須、そうでなければinvalid_request）。これによりオフラインでも動作し続けます：マニフェストのdisplayメンバーが保持します。enabledがfalseの場合はウィンドウを維持し、ディスプレイはオンのままです。マニフェストを再発行し、screen.display_changedを追加し、リビジョンを更新します（If-Matchが保護）。スクリーンはpairing_pendingまたはアクティブでなければなりません。
マニフェストがまだないスクリーン（未発行、またはプレイリストなし）はスケジュールを保存し、最初のマニフェストにそれが含まれます。プレイリストのないスクリーンは、プレイリストが割り当てられた時点で適用します。until のない上書きは、新しいスケジュールの次の境界に再設定されます。保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| enabled（必須、ブール値） | |
| windows（必須、配列） | Windows上でON。 |
リクエストテンプレートとレスポンス
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/display-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ディスプレイ状態を含むスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンスケジュールをクリア
ディスプレイスケジュールを削除します（上書きされない限り、ディスプレイはオンのままです）。何もない場合の解除は、変更なしで200を返します。保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/display-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ディスプレイ状態を含むスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 403 | OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません（docs/screen-scope.md）。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンの再起動スケジュールを取得
reboot_schedule（なければ null）と next_reboot_at、つまりバックエンドが次にスクリーンを再起動するウィンドウの開始（なければ null）を返します。ETag はスクリーンのリビジョンです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/reboot-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 再起動スケジュール。 | ScreenRebootScheduleView（application/json）；ヘッダー：ETag |
| 401 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンの再起動スケジュールを設定
再起動スケジュールを置き換えます：enabled と、1〜16個の screenrig.schedule/v1 ウィンドウ（days、start/end HH:MM。end <= start は開始日に属する日付またぎのウィンドウ、時刻なしは終日）。各ウィンドウは5分〜24時間です。
スクリーンのタイムゾーン（必須、指定がなければ invalid_request）で各ウィンドウが始まるたびに、バックエンドは POST /api/screens/{id}/reboot と同じ再起動を、Screen.commands の source schedule、screen.reboot_requested、および player.reboot の詳細とともに発行します。
春の時刻前進で存在しない時間帯に入る開始は、ウィンドウ内の最初の有効な分に実行されます。その日に有効な分がなく、ウィンドウ全体がその時間帯に含まれる場合は、screen.reboot_skipped の reason window_missed でスキップされます（next_reboot_at はその時間帯が終わる分を示します）。秋の時刻後退による繰り返しは、ウィンドウごと、現地の日付ごとに1回実行されます。
オンラインのスクリーンには再起動がすぐに送信されます。オフラインのスクリーンでは、ウィンドウが終わる（expires_at）までのみキューに保持されるため、遅れた再起動がウィンドウ外で実行されることはありません。人が依頼してスクリーンを待っている再起動を、スケジュールの実行が置き換えることはありません。その実行は screen.reboot_skipped の reason reboot_pending でスキップされます。
タイムゾーンを変更すると、待機中の予定済みの再起動はキャンセルされ、next_reboot_at は新しいゾーンに移動します。
スケジュールされたものでも依頼されたものでも、再起動は、送信後10分間、screen_offline、display_disconnected、crashing のアラートを発生させません。その間に送信期限を迎えたそれらの通知は、その期間の終了に待機時間を加えた時刻まで待機します（crashing の通知は planned_reboot としてスキップされます）。enabled false はウィンドウを保持し、何も再起動しません。
隙間がなく、後に続く開始がない時間ウィンドウは invalid_request です。スクリーンのホストヒントは reboot 機能を宣言している必要があり、そうでなければ 409 reboot_unsupported で何も保存されません。後から機能を失ったスクリーンは screen.reboot_skipped で各ウィンドウをスキップし、スケジュールは保持されます。
screen.reboot_schedule_changed を追加し、リビジョンを更新し（If-Match で保護されます）、マニフェストは再発行しません。スクリーンはアクティブである必要があります。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| enabled（必須、ブール値） | |
| windows（必須、配列） | 再起動ウィンドウ：バックエンドは、各ウィンドウの開始時にスクリーンのタイムゾーンでスクリーンを再起動します。各ウィンドウは5分〜24時間です。 |
リクエストテンプレートとレスポンス
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/reboot-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 再起動スケジュールと next_reboot_at を持つスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 402 | feature_not_in_plan — 予定された再起動は Plus に含まれます。enabled が true の場合に必要で、enabled が false の場合と DELETE では不要です。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンの再起動スケジュールをクリア
再起動スケジュールと next_reboot_at を削除します。すでに発行された再起動はキャンセルされません（キューにあるものは POST /api/screens/{id}/commands/{command_id}/cancel でキャンセルできます）。スケジュールがないときのクリアは 200 unchanged を返します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://screenrig.ai/api/screens/RESOURCE_ID/reboot-schedule'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 再起動スケジュールのないスクリーン。 | スクリーン（application/json）；ヘッダー：ETag、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーントーストを投稿
指定されたスクリーンに一時的なステージクロームトーストを投稿します。トーストはプリミティブではなく、キャンバススロットを占有せず、レイヤーもなく、準備完了やクロスフェードに参加しません。永続的なイベントタイプは既存のランタイムSSEストリーム上のscreen.toastです。ランタイムスキャンはexpires_at後にトーストを配信しないため、永続化されたカーソルは後で再生できません。
レベルカラーはPlayerのクロームであり、APIフィールドではありません。テキストは1～120文字で、改行はLFのみ許可され、最大3行までです。Playerはトーストを1行で表示し、LFはスペースとして表示します。
認識可能なScreenRig認証情報やその他の制御文字は拒否されます。duration_msはデフォルト60000で、2000～60000の範囲内でなければなりません。完全一致する Idempotency-Key の再試行は24時間オリジナルの expires_at を返します。最新優先で、キューもキャンセル動詞もありません。スクリーンメッセージは1クレジット API メーターの対象外です。
保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| レベル（必須、文字列） | 閉じた重大度トークン。Playerのchromeが塗りつぶしを選択；APIは色を持ちません。許可される値：「error」、「alert」、「info」 |
| text（必須、文字列） | 1～120文字。改行はLFのみ許可。最大3行まで。Playerはトーストを1行で表示し、LFはスペースとして表示します。その他の制御文字や認識可能なScreenRig認証情報は拒否されます。minLength：1 maxLength：120 |
| duration_ms（任意、整数） | 表示時間（ミリ秒）。省略時は60000。デフォルト：60000 最小：2000 最大：60000 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/toast'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。トーストはexpires_atまで永続的です。完全な冪等リトライは同じ有効期限を返します。 | ScreenToastAccepted（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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 | protected_target - スクリーンが保護されたスクリーンフォルダー内にある場合（docs/screen-scope.md。レビューを通じてフォルダーの保護を解除し、変更を行い、再度保護してください）。またはその操作のその他の競合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンストレージ予測
事前割り当て適合ドライラン：指定されたスクリーンに1つのプレイリストが割り当てられる前に適合するかどうかを、Screen.storage_forecastと同じターゲット選択（スクリーンの最後の報告容量、プランA.3のみ、遷移予測なし、ローカル扱いなし）で回答します。
何も書き込みません：割り当てもスクリーン改訂もイベントもなく、スクリーンのstorage_forecast読み取りモデルは変更されません。プロジェクトベアラーが権威であり、他プロジェクトのスクリーンやプレイリストはnot_foundです。スクリーンにストレージレポートがないか、プレイリストのコンテンツ参照が準備できていない場合、fitは不明で両方のバイト数はnullです。
オプションのplaylist_revisionは、呼び出し元が読み取ってから変更されたプレイリストをrevision_conflictで拒否します。24時間以上前のレポートは古いですが、Screen.storage_forecastと同様に予測に使われます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| playlist_id（必須、文字列） | minLength: 1 |
| playlist_revision（任意、整数） | オプションの期待されるプレイリストリビジョン。異なる保存済みリビジョンはrevision_conflictで予測は返されません。最小値：1 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/storage-forecast'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ドライラン予測。fit unknownは予測するデータがないことを意味し、バイト数とreceived_atはnullです。 | ScreenStorageForecastDryRun（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 412 | revision_conflict — playlist_revision がプレイリストの現在のリビジョンではありません。予測は返されません。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンのキャンペーンを説明
プロジェクトの各キャンペーンがこのスクリーンで再生される理由、または再生されない理由を、優先順に示し、スクリーンの有効なプレイリストも示します。items と effective_playlist はスクリーンの現在の状態です。
at（必要なら to も）を指定すると、境界スイープが実行するのと同じリゾルバーにその時刻を問い合わせ、テイクオーバー、各キャンペーン、各スケジュールエントリの判定（won、outranked、not_started、ended、outside_hours、off）と、その時刻のプレイリスト、そして応答が判定しない内容を返します。
to も指定すると、at.timeline に at から to までの、プレイリストが変わらない区間が一覧されます。スケジュール、テイクオーバー、キャンペーンは現在の状態で読み取られます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| 時刻 | クエリ | オプション | 説明する時刻。タイムゾーン付きの RFC 3339（2026-03-08T09:30:00Z または 2026-03-08T01:30:00-08:00）か、スクリーン自身の時計の時刻（2026-03-08T09:30、秒は省略可）で指定します。夏時間でスキップまたは繰り返される時計の時刻は at を示す invalid_request で拒否され、繰り返される場合は選べる2つの時刻が示されます。 to だけを指定した場合のデフォルトは現在です。 |
| から | クエリ | オプション | at から始まる切り替えのタイムラインの終了時刻で、at と同じ2つの形式で指定します。at より後で、どこまで先でも制限はありません。1回の応答には最大500区間が含まれ、変更のない8日間は1区間として数えられます。timeline_truncated は to に達する前に打ち切られたことを示します。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/screens/RESOURCE_ID/campaigns'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーン上のすべてのキャンペーンの状況。 | ScreenCampaigns（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) |
スクリーンのスクリーンショットを取得
指定されたスクリーンの現在の準備済みWebPを返します。オプションのcapture_idはその準備済みスロットと一致する必要があります。アップロードなしで期限切れのcapture_idはscreenshot_unavailableです。後のリクエストで置き換えられたcapture_idはresource_conflictです。画像バイトは署名付きURLやオブジェクトキーではありません。Rangeは受け付けません。
スクリーンメッセージは1クレジットのAPIメーターの対象外です。ETagは保存されたWebPの強力なSHA-256です。ダッシュボードセッションのレスポンスはプライベートでno-cache、ダッシュボードのIf-None-Matchが現在の画像と一致し、スクリーンとキャプチャがセッションのプロジェクトで解決された後にチェックされ、304を返し保存されたバイトを開きません。
プロジェクトのベアラーレスポンスはプライベートで no-store です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| capture_id | クエリ | オプション | |
| If-None-Match | ヘッダー | オプション | このルートが返したスクリーンショットの強力な ETag。ダッシュボードセッションで尊重されます。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/screenshot'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在の準備済み静止画はWebPです。 | string (image/webp); ヘッダー: Content-Type, Content-Length, ETag, X-ScreenRig-Capture-ID, X-ScreenRig-Captured-At, Cache-Control, Content-Disposition |
| 304 | ダッシュボード セッションのみ。現在の画像のETagがIf-None-Matchと一致します。本文は生成されず、オブジェクトストレージは読み込まれません。キャプチャヘッダーは現在のキャプチャ名を示し、後のキャプチャが同じバイトにエンコードされた場合、保存された応答と異なることがあります。 | 本文なし；ヘッダー：ETag、Cache-Control、X-ScreenRig-Capture-ID、X-ScreenRig-Captured-At |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 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) |
スクリーンのスクリーンショットを依頼
指定されたアクティブスクリーンの静止スクリーンショットを1枚要求します。最新優先：新しいリクエストは進行中の capture_id を置き換え、409 を返しません。現在の準備済みスロットは後のアップロード成功まで保持されます。capture_id はオプションの環境プレフィックス、次に shot_ とランダムなサフィックス。expires_at は受理後30秒です。
永続イベントタイプは既存のランタイムSSEストリーム上のscreen.screenshot_requestedです。expires_at後はランタイムスキャンで配信されません。イベント詳細はname、capture_id、expires_at、max_width_divisor 2、max_height_divisor 2、format image/webp、quality 80、max_bytes 2097152です。画像バイトはSSEに現れません。
前払い残高はゲートではなく、このスクリーンメッセージパスは1クレジットAPIメーターから免除されています。同一のIdempotency-Keyによる再試行は、元のcapture_idと24時間有効なexpires_atを返します。
ダッシュボード経路では、共有タブを確認するため、POST /api/tab-sharesと同様にChromeまたはFirefox拡張機能のオリジンから要求できます（GET /api/screens/{id}/screenshot/statusとGET /api/screens/{id}/screenshotにオリジン規則は不要です）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | 必須 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' 'https://screenrig.ai/api/screens/RESOURCE_ID/screenshot'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 承諾されました。リクエストはexpires_atまで永続的です。完全な冪等リトライは同じcapture_idと有効期限を返します。 | ScreenScreenshotAccepted（application/json）；ヘッダー：Cache-Control、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンショットの状態を取得
このプロジェクトに存在する場合、指定されたスクリーンのスクリーンショット状態機械を返します。idleはリクエストも準備済みスロットもありません。pendingはexpires_at前の現在のcapture_idでアップロードなしです。readyは最後の成功したアップロードが現在のcapture_idと一致します。timed_outは現在のIDがexpires_atに達しアップロードなしです。
タイムアウトは遅延処理です：期限切れ後の最初のステータスGETまたは次のPOSTがそれを記録し、理由expiredでscreen.screenshot_failedを一度だけ追加します。タイムアウトしたリクエストは古いreadyスロットを削除しません。スクリーンメッセージは1クレジットのAPIメーターから除外されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/screenshot/status'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | このプロジェクトのスクリーンのスクリーンショットステータス。 | ScreenScreenshotStatus（application/json）；ヘッダー：Cache-Control |
| 401 | 安定した 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) |
| 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) |
スクリーンのライブセッションを取得
Returns the screen's live session after lazy expiry: idle when it has none, requested while the Player has been asked to publish, publishing once the media relay holds its video, ended with ended_reason (stopped, expired, consent_denied, consent_timeout, capture_failed, connection_failed or player_stopped; an open enum) for ten minutes after it ended. publisher.connected is true only while the Player's last report, at most 45 seconds old, said it is connected; it is the Player's own word, not proof of picture. 404 feature_unavailable when the server has no media relay configured.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/live'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | スクリーンのライブセッション。 | LiveSession（application/json）；ヘッダー：Cache-Control |
| 401 | 安定した 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) |
| 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) |
スクリーンのライブセッションを開始
Starts live view of the named screen, or renews the one it has (docs/player-compatibility.md §6.10): sub-second video of what the screen plays, from the Player through a media relay to the dashboard. A screen has one live session, shared by every viewer.
Its lease runs duration_s from now (30 to 300, default 300) and a start or renewal sets lease_until to the later of its current end and that instant, never past max_until, five minutes after the session began. The session ends by itself at the latest then: nothing renews or restarts it, and a new session needs a new start.
リースが更新なしで期限切れになったとき、DELETE を受けたとき、または Player が終了したときは、それより早く終了します。Player はリース終了から約 20 秒以内に配信を止めます。
With live_id the request only renews that session: when it is not the screen's live session (it ended, or the screen started another) the answer is 409 live_unavailable naming ended_reason, and no session starts or is extended.
新しいセッションは、画面ごとのランタイムコマンド player.live_publish を追加します（詳細は live_id、at、60 秒後の expires_at、max_until。expires_at を過ぎると配信されません）。更新では、Player が一度も参加しておらず、直前のコマンドが期限切れの場合にだけ再送します。
The screen must be active and online and its host hint must declare the live_view capability: 409 live_unsupported (update the Player, or use a screenshot), 409 live_unavailable (offline), screen_archived. 404 feature_unavailable when the server has no media relay configured. 201 is a new session, 200 a renewed one; both return the LiveSession with a viewer_url that opens the dashboard viewer.
requested の状態は Player が配信を始めるまで続きます。publisher.connected になるまで GET をポーリングしてください。ライブビューは無料で、スクリーンショットと同様に 1 クレジットの API メーターの対象外です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| duration_s（任意、整数） | 今から数えたリースの長さ（秒）。リースに関係なく、セッションは最長 5 分です。default: 300 minimum: 30 maximum: 300 |
| live_id（任意、文字列） | Renew this session only. When it is not the screen's live session, the answer is live_unavailable (the detail names ended_reason) and nothing starts or is extended. Without it, a start begins a session when the screen has none. pattern: "^lv_[a-z2-7]{26}$" |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/live'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 新しいライブセッション。Player に配信が要求されました。 | LiveSession（application/json）；ヘッダー：Cache-Control, RateLimit-Policy, RateLimit |
| 200 | 更新されたスクリーンのライブセッション。 | LiveSession（application/json）；ヘッダー：Cache-Control, RateLimit-Policy, RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンのライブセッションを停止
Ends the screen's live session (ended_reason stopped), appends player.live_stop (details live_id, at, expires_at sixty seconds later), and closes its tracks on the media relay. 204 also when the screen has no live session. A Player that misses the command stops at its next heartbeat. 404 feature_unavailable when the server has no media relay configured.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/live'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | 停止しました。または停止するものがありませんでした。 | 本文なし；ヘッダー：Cache-Control |
| 401 | 安定した 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) |
| 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) |
スクリーンのライブビューアーを作成
画面のライブセッションのビューアーを開きます。Player の映像を購読する新しいメディアリレーセッションと、リレーの WebRTC オファーが返ります。
Apply offer with setRemoteDescription on an RTCPeerConnection built with ice_servers (short-lived credentials), create the answer, wait for ICE gathering to complete or two seconds, then PUT the answer to /api/screens/{id}/live/viewers/{viewer_id} within two minutes.
Candidates travel inside the SDP; there is no separate candidate call. 409 live_not_ready while the session is requested, 409 live_unavailable when the screen has no live session or it ended (the detail names ended_reason). 404 feature_unavailable when the server has no media relay configured.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/live/viewers'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | ビューアーとリレーのオファー。 | LiveViewer（application/json）；ヘッダー：Cache-Control, RateLimit-Policy, RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンのライブビューアーに応答
Applies the viewer's WebRTC answer to the relay's offer. A viewer answers once, within two minutes of its offer; an unknown, expired, already answered or another screen's viewer_id is 404 not_found. 204 once the relay accepts the answer; media then flows from the relay to the viewer. 404 feature_unavailable when the server has no media relay configured.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| viewer_id | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| answer（必須、SessionDescription） |
リクエストテンプレートとレスポンス
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/screens/RESOURCE_ID/live/viewers/VIEWER_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | リレーが応答を受け付けました。 | 本文なし；ヘッダー：Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 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) |
スクリーンのライブフレームを開始
Starts JPEG frames of the screen's live session, for an agent that has HTTPS and no WebRTC: the media relay decodes the Player's published video and delivers one JPEG about every second, and GET /api/screens/{id}/live/frame returns the latest.
セッションが配信中である必要があります（それまでは 409 live_not_ready、セッションがない、または終了している場合は 409 live_unavailable。POST /api/screens/{id}/live で開始してください）。
Frames are started once per session: asking again answers the same adapter's progress, and a Player that reconnects ends its frames, so ask again. state is starting until the first frame arrives, streaming while frames arrive, and silent when the adapter is older than fifteen seconds and none has arrived in that time (last_frame_at, when present, says when frames last came).
The frames end with the session. 404 feature_unavailable when the server has no media relay or no frames origin configured. Live frames are free and exempt from the 1-credit API meter, like a screenshot. They are what the Player's encoder sent, scaled and lossy; they do not replace a screenshot as proof of layout.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/live/frames'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | フレームアダプターと、その進捗。 | LiveFrames（application/json）；ヘッダー：Cache-Control, RateLimit-Policy, RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
スクリーンのライブフレームを取得
スクリーンのライブセッションの最新の JPEG フレームを返します。
Without after it returns the latest frame there is; with after (the ScreenRig-Captured-At of the frame you already have) it returns the first frame captured later, waiting up to five seconds for one, so a loop that passes each answer's ScreenRig-Captured-At back as after receives every new frame once.
ScreenRig-Captured-At は、バックエンドがフレームを受信した時刻です。
When no new frame comes in time the answer is 409 live_not_ready with Retry-After: 1; 409 resource_conflict answers a session whose frames were not started (POST /api/screens/{id}/live/frames first, and again after the Player reconnects); 409 live_unavailable answers a session that has ended or whose adapter is silent.
Frames are relay-decoded JPEGs of the live stream, at most 1280 by 720: they show what the Player encoded and sent, not a screenshot. They end with the session (max_until at the latest). 404 feature_unavailable when the server has no media relay or no frames origin configured. Free and exempt from the 1-credit API meter.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| 以降 | クエリ | オプション | この時刻より後に取得されたフレームを返します（RFC 3339。ScreenRig-Captured-At と同じ形式）。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/screens/RESOURCE_ID/live/frame'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | フレーム。 | string（image/jpeg）；ヘッダー：Content-Type, Content-Length, ETag, Cache-Control, ScreenRig-Live-Id, ScreenRig-Captured-At, ScreenRig-Frame-Width, ScreenRig-Frame-Height, RateLimit-Policy, RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
ライブフレームを接続
The media relay's frame adapter connects here with a WebSocket upgrade; no client, agent or Player calls it. The token is the credential: POST /api/screens/{id}/live/frames hands it to the relay inside the adapter's endpoint and stores only its SHA-256.
Each binary message the relay sends is one protobuf Packet (field 1 sequenceNumber, field 2 timestamp, field 5 payload) whose payload is one whole JPEG of at most 2 MiB; anything else is skipped. The backend keeps the latest frame for fifteen seconds. One connection per token: a newer one replaces the older.
The connection is closed with 1000 when the live session ends, and a token of an ended session is refused with 401 before the upgrade. 404 feature_unavailable when the server has no frames origin configured.
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| トークン | クエリ | 必須 | アダプターのトークン（43 文字）。 |
リクエストテンプレートとレスポンス
curl --request GET 'https://api.screenrig.ai/live/frames?token=TOKEN'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 101 | WebSocket にプロトコルを切り替えます。 | 本文なし |
| 401 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
スクリーンのヘルス履歴を取得
スクリーンが時間経過で報告したヘルス。resolution=raw（デフォルト）は時系列で各受理報告を返し、Screen.healthのstaleなしの形状。resolution=hourはUTC時間ごとに1つの要約（報告数、ピークと平均温度、ピーク負荷とメモリ比率、最弱Wi-Fi信号、ディスプレイ切断の有無、ピーククラッシュとレンダラー再起動数）。from（含む）とto（除く）はデフォルトで過去24時間。範囲はrawで最大31日、hourで最大93日。
ページは最大 limit 行（デフォルト100、最大500）を保持し、next_cursor を含みます。終端は null です。履歴はプランのイベント保持に従います。生レポートは数秒でこのビューに到達し、時間別集計は約5分で到達します。別プロジェクトのスクリーンは not_found です。Screen.health（最新レポート）は変更されません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| フォーマット | クエリ | オプション | json（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。 |
| 開始 | クエリ | オプション | レポート時間の包括的下限。デフォルトは to の24時間前。 |
| から | クエリ | オプション | レポート時間の排他的上限。デフォルトは現在。 |
| 解決 | クエリ | オプション | raw は各レポートを返し、hour は UTC 時間ごとの集計を返します。 |
| 制限 | クエリ | オプション | ページサイズ。 |
| カーソル | クエリ | オプション | 前のページの next_cursor。同じフィルター付き。不透明。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/health/history'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | レポートまたは時間別集計のページ。 | スクリーンヘルス履歴（application/json）；ヘッダー：Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 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) |
スクリーンの稼働時間を取得
1つのスクリーンの包括的なUTC日単位の毎日の可用性（day_toはデフォルトで今日、day_fromは最大366日前の29日前）。各行にはその日のオンラインおよびオフライン秒数、可用性（記録された時間に対するオンラインの割合、記録がない場合はnull）、およびカバレッジ（記録された状態のある日の割合）が含まれます。
状態が記録されていない時間はダウンタイムとしてカウントされません：カバレッジのみが低下します。スクリーンの現在の開いている間隔は今まで含まれ、その日をライブとしてマークします。記録がない日は行がありません。オフラインはスクリーンが60秒間到達不能になった後に記録されます。別プロジェクトのスクリーンはnot_foundです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| フォーマット | クエリ | オプション | json（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。 |
| day_from | クエリ | オプション | 最初の UTC 日（含む）。day_to の 29 日前がデフォルトです。day_to と合わせて最大 366 日。 |
| day_to | クエリ | オプション | 最終UTC日（含む）。デフォルトは今日（UTC）。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/uptime'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 毎日の稼働時間行、古い順。 | ScreenUptime（application/json）；ヘッダー：Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 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) |
スクリーンのプレゼンスを取得
スクリーンのオンラインおよびオフラインの遷移。最新が最初。screen.online と screen.offline イベントから、ログレーンが保存するもの。since（含む）と until（除く）はイベント時間の境界。until はデフォルトで現在、since は最大 366 日前の 30 日前。遷移はプランのイベント保持期間に保持されます。
ページは最大 limit 遷移（デフォルト100、最大500）を保持し、next_cursor を含みます。終端は null です。オフライン遷移はスクリーン再接続時にサーバーが検知し、detected_on_reconnect を持ち、その at はプレゼンスリース終了時刻です。オフラインはスクリーンが60秒間到達不能後に記録されます。
別のプロジェクトのスクリーンはnot_foundです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| 以降 | クエリ | オプション | 遷移イベント時間の包括的下限。デフォルトは until の30日前。 |
| まで | クエリ | オプション | 遷移イベント時間の排他的上限。デフォルトは現在。until - since は最大366日。 |
| 制限 | クエリ | オプション | ページサイズ。1〜500の範囲外の値はinvalid_requestで拒否され、limitを指定します。 |
| before | クエリ | オプション | 前のページの next_cursor。同じ since と until 付き。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/screens/RESOURCE_ID/presence'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | プレゼンス遷移、新しい順。 | スクリーンプレゼンス履歴（application/json）；ヘッダー：Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| 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) |
Health Trend を取得
プロジェクトのフリートの健康状態をUTC時間ごとに示します：報告したスクリーン数、80℃以上の高温、ディスプレイ切断、24時間に3回以上のクラッシュのスクリーン数。from（含む）とto（除く）は最大93日間の過去24時間がデフォルトです。ページは最大limit行（デフォルト100、最大500）を保持し、next_cursorは最後でnullです。
時間別は、レポートから最大約5分遅れます。スクリーンに限定された呼び出し元には拒否されます（outside_screen_scope）。スクリーン単位の形式は GET /api/screens/{id}/health/history です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| フォーマット | クエリ | オプション | json（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。 |
| 開始 | クエリ | オプション | レポート時間の包括的下限。デフォルトは to の24時間前。 |
| から | クエリ | オプション | レポート時間の排他的上限。デフォルトは現在。 |
| 制限 | クエリ | オプション | ページサイズ。 |
| カーソル | クエリ | オプション | 前のページの next_cursor。同じフィルター付き。不透明。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/health/trend'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 時間別フリートヘルスのページ。 | HealthTrend（application/json）；ヘッダー：Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プロジェクトの稼働時間を取得
プロジェクトのスクリーンの包括的なUTC日ごとの日次稼働状況（GET /api/screens/{id}/uptimeと同様のデフォルトと範囲）。各行はその日に記録状態のあるスクリーンのオンラインおよびオフライン秒数を合計し、カバレッジはその日の記録状態のあるスクリーンの割合です。
インターバルは終了時に数えられるため、今日の行にはここまでに終了したインターバルが含まれます。ライブのオンライン数はダッシュボードの概要にあります。スクリーンに限定された呼び出し元には拒否されます（outside_screen_scope）。スクリーン単位の形式は GET /api/screens/{id}/uptime です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| フォーマット | クエリ | オプション | json（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。 |
| day_from | クエリ | オプション | 最初の UTC 日（含む）。day_to の 29 日前がデフォルトです。day_to と合わせて最大 366 日。 |
| day_to | クエリ | オプション | 最終UTC日（含む）。デフォルトは今日（UTC）。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/uptime/daily'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 毎日の稼働時間行、古い順。 | ProjectUptime（application/json）；ヘッダー：Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
フリートリンク一覧
プロジェクトのフリートリンクを最も古いものから最大50件まで一覧表示します。以下の有効なManageでは各URLは空でurl_redactedがtrueです。URLはスクリーンを作成します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/fleet-links'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | プロジェクトのフリートリンクです。 | FleetLinkList（application/json）；ヘッダー：Cache-Control |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
フリートリンクを作成
フリートリンクを作成します：一つの Player URL（https://play.<domain>/player/#fleet=<secret>）で、開いたすべてのデバイスがこのプロジェクトの独自のスクリーンになります。ペアリングコードは不要です。Google 管理コンソールのキオスクアプリなどのデバイスマネージャーに配置してください。
新しいスクリーンにはリンクのタグ、フィールド、プレイリスト、デバイスからのラベル（管理者資産ID、次にロケーション）、それ以外は次のデフォルトラベルが付きます。すでにスクリーンを保持しているプレーヤーは新たに作成しません。キーは再読み込みや再起動後もスクリーンの識別子として維持されます。
パワーウォッシュまたは再インストール後、このプロジェクトのフリートリンクが作成したスクリーンのシリアルまたはDUIDを報告するデバイスは、古いキーが10分間サイレント状態であれば新しいスクリーンを作成せずにそのスクリーンを回復します（screen.recovered）。
シークレットは URL フラグメントで渡され、ブラウザーがサーバーに送信することはありません。max_screens はリンクが作成するスクリーンの数を制限し、expires_at はその時刻にリンクを終了します（無効にした場合と同じです）。組織に作成できるフリートリンクは、すべてのプロジェクトを合わせて最大50件です（fleet_link_limit_reached）。fleet_link.created を追加します。
同じ Idempotency-Key を付けた正確な再試行には、24時間同じ回答が返されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| ラベル（必須、文字列） | minLength: 1 maxLength: 80 |
| enabled（任意、ブール値） | デフォルトはtrueです。 |
| タグ（オプション、ScreenTags） | フリートセレクタータグ（0〜16件の一意なタグ、各タグはメディアタグ構文に準拠）。ScreenPatch では配列全体が置き換えられ、空配列で全タグがクリアされます。重複や不正なタグはinvalid_requestです。タグを変更するとスクリーンのリビジョンが更新され（If-Matchで保護）、screen.updatedにdetails.tagsが追加されます。マニフェストリビジョンは変更されません。 タグはランタイムマニフェストにも認証にも決して含まれません。 |
| fields（任意、オブジェクト） | リンクが作成する各スクリーンの初期フィールドです。カード配置は {screen.field.NAME} でそれらを読み取ります。 |
| playlist_id（任意、文字列） | |
| max_screens（任意、整数） | 最小値: 1 最大値: 10000 |
| expires_at（任意、文字列） | リンクの有効期限です（RFC 3339）。期限を過ぎたリンクはスクリーンを作成も復元もしません。省略すると期限はありません。すでに過ぎた時刻も受け付けられ、その場合はリンクが直ちに期限切れになります。format: "date-time" |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/fleet-links'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | URLとともに作成されました。 | FleetLink（application/json）；ヘッダー：Cache-Control |
| 400 | invalid_request - 不明な playlist_id、または不正なタグやフィールドがあります。 | 問題 (application/problem+json) |
| 409 | fleet_link_limit_reached または idempotency_mismatch。 | 問題 (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つのフリートリンク。Manage有効URLは空でurl_redactedはtrueです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/fleet-links/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 1つのフリートリンク。 | FleetLink（application/json）；ヘッダー：ETag、Cache-Control |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
フリートリンクを更新
label、enabled、tags、fields、playlist_id、max_screens、expires_at のいずれかを変更します。null を指定すると fields、playlist_id、max_screens、expires_at がクリアされます。無効または期限切れのリンクはスクリーンの作成も回復も行わず、それを開いたデバイスには代わりにペアリングコードが表示されます。変更は、リンクがこれから作成するスクリーンに適用され、すでに作成済みのスクリーンには適用されません。
fleet_link.updated を追加します。If-Match がリビジョンを保護します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| ラベル（任意、文字列） | minLength: 1 maxLength: 80 |
| enabled（任意、ブール値） | |
| タグ（オプション、ScreenTags） | フリートセレクタータグ（0〜16件の一意なタグ、各タグはメディアタグ構文に準拠）。ScreenPatch では配列全体が置き換えられ、空配列で全タグがクリアされます。重複や不正なタグはinvalid_requestです。タグを変更するとスクリーンのリビジョンが更新され（If-Matchで保護）、screen.updatedにdetails.tagsが追加されます。マニフェストリビジョンは変更されません。 タグはランタイムマニフェストにも認証にも決して含まれません。 |
| fields（任意、オブジェクト） | プリセット全体を置き換えます。{} または null でクリアされます。 |
| playlist_id（任意、文字列） | null はプレイリストをクリアします。 |
| max_screens（任意、整数） | null は上限を解除します。最小値：1 最大値：10000 |
| expires_at（任意、文字列） | null を指定すると有効期限が削除されます。format: "date-time" |
リクエストテンプレートとレスポンス
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/fleet-links/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | フリートリンクを更新しました。 | FleetLink（application/json）；ヘッダー：ETag |
| 400 | invalid_request。 | 問題 (application/problem+json) |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
フリートリンク削除
フリートリンクを削除します。URLは即座に無効になり、作成したスクリーンはプレイリスト、タグ、フィールド付きで残ります。fleet_link.deletedを追加します。If-Matchでリビジョンを保護します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/fleet-links/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | 削除されました。 | 本文なし |
| 412 | revision_conflict。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
Fleet Link を回転
リンクのシークレットを置き換え、新しいURLを返します。古いURLは即座に無効になります。すでに作成されたスクリーンは再生を続けます。ペアリングされたPlayerはリンクを再表示しません。fleet_link.updatedにdetails.rotated trueを追加します。If-Matchでリビジョンを保護します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/fleet-links/RESOURCE_ID/rotate'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 新しいURLを持つフリートリンク。 | FleetLink（application/json）；ヘッダー：ETag、Cache-Control |
| 412 | revision_conflict。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |