OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 6 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
ホームページのブラウザ引き継ぎ
ブラウザリンクを請求
認証されたプロジェクトのブラウザリンクコードを1つ請求し、正確に1つの最初のpairing_pendingスクリーンと既存のブラウザプロビジョニング権限を原子操作で作成します。登録はプロジェクトのみです。レスポンスは安全なメタデータのみで、プロビジョニングトークン、フラグメントURL、クッキー、証明は含みません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| code（必須、文字列） | パターン: "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$" |
リクエストテンプレートとレスポンス
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/project/browser-links/claim'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 正確なリプレイ安全なフラグメントなしブラウザリンクのクレーム。 | BrowserLinkClaim（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) |
| 403 | 安定した 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) |
| 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
ブラウザリンク状態を取得
読み取り専用ポーリングのフォールバックで、所有するapexブラウザリンククッキーでのみ認証されます。安全なステータスメタデータと固定継続パスを返し、プロビジョニングURLやトークンは返しません。
リクエストテンプレートとレスポンス
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 安全な状態を請求済み。 | BrowserLinkStatus（application/json）；ヘッダー：Cache-Control、Referrer-Policy |
| 202 | ブラウザリンクは存在しますが、まだクレームされていません。 | BrowserLinkStatus（application/json）；ヘッダー：Cache-Control、Referrer-Policy |
| 401 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 410 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| デフォルト | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
ブラウザリンク開始
24時間の未請求ブラウザリンクセッションを作成または再利用する厳格な同一オリジンの JavaScript 非対応 POST。期間内に請求すると、新しい独立した10分間の保護されたプロビジョニング配信ウィンドウを作成。クッキーによる Player ペアリングは24時間持続。
ネイティブペアリングは別の72時間の未請求ロケーターです。請求されたネイティブ配信は署名完了または明示的なプレーヤーリセットまで持続します。これは正確に apex ホスト専用の Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link クッキーをDomainなしで設定します。
JSONクライアントは201を受け取り、Accept text/htmlは/bodyなしの303で/setupにリダイレクトします。不安全なlocalhostフォールバックはなく、開発は設定されたHTTPSループバックオリジンが必要です。
リクエストテンプレートとレスポンス
curl --request POST 'https://screenrig.ai/screen/browser-links'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 安全なブラウザーリンクコード／ステータスメタデータ。 | BrowserLinkSession（application/json）；ヘッダー：Cache-Control、Referrer-Policy、Set-Cookie、RateLimit-Policy、RateLimit |
| 303 | No-JavaScriptフォームの続きで読み取り専用セットアップページです。 | 本文なし；ヘッダー：Location、Cache-Control、Referrer-Policy、Set-Cookie |
| 403 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 409 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 429 | Player 対応のランタイムまたはコンテンツルートでの安定した rate_limited 問題応答。ランタイムドキュメント形式（RuntimeProblem）。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | ランタイム問題（application/problem+json）；ヘッダー：Retry-After、RateLimit-Policy、RateLimit |
| 500 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| デフォルト | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
ストリームブラウザリンクイベント
所有クッキーのみで再生可能なSSEでLast-Event-IDを使用。イベントデータは安全な状態フィールドのみを含みます。プロビジョニングURL/トークンは含まず、プロジェクトイベントストリームは使用しません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| Last-Event-ID | ヘッダー | オプション | afterがない場合に使用される耐久カーソル。 |
リクエストテンプレートとレスポンス
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | Browser-link 発行／請求ステータス SSE。 | string (text/event-stream); ヘッダー: Cache-Control, Referrer-Policy, X-Accel-Buffering |
| 400 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 401 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 410 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| デフォルト | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
ブラウザーリンクを続行
ナビゲーション専用の所有クッキー認証 GET。クレーム後はボディなしの303を返し、その Location は正確な Player /s/<public_id>#provision=<token> URL です。Location は CORS、JSON、SSE、ポーリング、ログ、トレース、メトリクス、分析、イベント、エラーを通じて公開されず、短い配信修復ウィンドウ中のみ冪等です。
リクエストテンプレートとレスポンス
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 303 | Playerプロビジョニングフラグメントへの本文なしリダイレクト。 | 本文なし；ヘッダー：Location、Cache-Control、Referrer-Policy |
| 401 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 409 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| 410 | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
| デフォルト | Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式（RuntimeProblem）。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | ランタイム問題（application/problem+json） |
ブラウザリンク設定ページを取得
読み取り専用のセットアップ手順。コードなしでは所有するブラウザリンククッキーがステータスを提供します。コードありでは公開専用の手順を返し、無効または期限切れのコードには一般的な404を使用します。text/markdownまたはformat=markdownは公開コードフォームにMarkdownを選択します。プロビジョニングURLやトークンは返しません。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| code | クエリ | オプション | 副作用のないセットアップ手順のための公開セットアップコード。クッキー不要。 |
| フォーマット | クエリ | オプション |
リクエストテンプレートとレスポンス
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 安全なnoindex設定HTML。 | string (text/html); ヘッダー: Cache-Control, Referrer-Policy, X-Robots-Tag |
| 401 | 安定した 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) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |