API リファレンス

エージェント接続 API

エージェントのインストールと接続

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

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

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

エージェントのインストールと接続

POST/api/agent-identity/revoke

エージェントIDを取り消す

グローバルID、そのすべてのID認証情報とプロジェクトトークン、および保留中の接続を取り消します。取り消されたID認証情報での正確な再送は、別の遷移なしに成功します。プロジェクトの所有権とコンテンツは残ります。Cookie、Origin、クエリ、またはボディは受け付けません。このルートはAPIメーターを課金しません。

identity スコープを持つエージェントアクセス JWT は、identity アクセス(読み取り専用、提案、管理のいずれか)を付与し、それを取り消し、identity のすべての OAuth グラントも取り消します。トークンは数秒で拒否されます。取り消し後に同じ JWT で再試行すると無操作で成功します。

認証
agentIdentityBearer
リクエスト本文
なし
操作ID
revokeAgentIdentity
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'

レスポンス

ステータス意味本文とヘッダー
204識別が取り消されました。本文なし;ヘッダー:Cache-Control
デフォルト

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

問題 (application/problem+json)
GET/api/agents/self

現在のエージェントを取得

呼び出し元プロジェクトのベアラーにリンクされたエージェントのインストールとconnection_readyを返します。プロジェクトは少なくとも1人のメンバーがpasskeyまたはpasswordを持つと準備完了です。IDステータスは診断用でAPIメーターを消費しません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200現在のエージェントとプロジェクトの接続準備状況。AgentSelfStatus(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)
POST/api/agents/self/disconnect

現在のエージェントを切断

呼び出し元のプロジェクトメンバーシップとそのプロジェクトトークンのみを取り消し、グローバルID、他のメンバーシップ、プロジェクトおよびコンテンツは保持します。同じ暗号的に有効な取り消されたベアラーで繰り返すことは、何もしない成功操作です。最後のアクティブエージェントを切断すると、allow_last_agent が明示的でない限り agent_lockout_risk を返します。APIメーターは課金しません。

読み取り専用を含むエージェントアクセス JWT は、エージェントをトークンのプロジェクトから切断します。メンバーシップは終了し、プロジェクトの同意はエージェントのグラントから外れ、その identity/project ペアは古いアクセストークンで切断されます。トークン内の他のプロジェクトは動作を続けます。切断後に同じ JWT で再試行すると無操作で成功します。

認証
revocableAgentBearer
リクエスト本文
AgentDisconnectRequest
操作ID
disconnectCurrentAgent

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。

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

フィールド説明
allow_last_agent(任意、ブール値)最後のアクティブなエージェントベアラーの喪失を明示的に許容します。登録済みのダッシュボードパスキーは独立した管理権限を保持します。デフォルト: false
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'

レスポンス

ステータス意味本文とヘッダー
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)
409

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

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

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

問題 (application/problem+json)