API リファレンス

セットアップコード API

ウェブサイトのセットアップコード

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

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

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

ウェブサイトのセットアップコード

POST/website/setup-codes

訪問者のセットアップコードを取得

ウェブサイトのエージェント用プロンプトからの、認証なしの同一オリジン呼び出しです。リクエストのファーストパーティ訪問者 Cookie(sr_vid)のセットアップコードを返し、初回は発行します。同じ訪問者には、有効な間(発行から 90 日)同じコードが返されます。

ユーザーがセットアッププロンプトとともにエージェントに貼り付け、エージェントがそれを CLI のエンロールメントに渡すと、新しいプロジェクトがその訪問に関連付けられます。ウェブサイトの Origin が必要です。形式の正しい訪問者 Cookie がちょうど 1 つない場合は 204 を返し、何も発行しません。コードは何も許可せず、訪問を示すだけです。

クライアント IP ごとに 1 時間あたり最大 60 個の新しいコード(IPv6 は /64 単位)。すべてのリクエストで IP あたり毎分 120 件の制限を共有します。Retry-After が優先されます。

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

パラメーター

名前送信する必須?説明
オリジンヘッダー必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'

レスポンス

ステータス意味本文とヘッダー
200訪問者のセットアップコード。WebsiteSetupCode(application/json);ヘッダー:Cache-Control
204リクエストに訪問者の Cookie がなかったため、示す訪問がありません。本文なし;ヘッダー:Cache-Control
デフォルト

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

問題 (application/problem+json)