API リファレンス

キー/値ストレージ API

アプリケーション キー/バリュー ストレージ

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

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

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

アプリケーション キー/バリュー ストレージ

GET/api/applications/{application_id}/kv

KV 一覧

昇順のキー順で最大200件返します。next_cursorは最後に返されたキーで、次ページ取得時にafterとして渡します。エントリーがない場合next_cursorはnullです。ダッシュボードセッションは、ウェブアプリのプレビューのため、ここでプロジェクトのエントリーを読み取ります。ダッシュボードには KV 書き込みがありません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listKV

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200KVエントリKVList(application/json)
デフォルト

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

問題 (application/problem+json)
GET/api/applications/{application_id}/kv/{key}

KV を取得

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getKV

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200KVエントリKVEntry(application/json)
デフォルト

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

問題 (application/problem+json)
PUT/api/applications/{application_id}/kv/{key}

KVをPUT

認証
projectBearer
リクエスト本文
KV書き込み
操作ID
putKV

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
application_idパス必須
キーパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。キーの作成または上書き時は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

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

フィールド説明
value_base64(必須、文字列)maxLength:1398104
content_type(任意、文字列)デフォルト:「application/octet-stream」minLength:1 maxLength:127
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'

レスポンス

ステータス意味本文とヘッダー
200KVエントリKVEntry(application/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)
削除/api/applications/{application_id}/kv/{key}

KV削除

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

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
application_idパス必須
キーパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'

レスポンス

ステータス意味本文とヘッダー
204削除済み本文なし
デフォルト

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

問題 (application/problem+json)
GET/api/applications/{application_id}/kv-webhooks

KVWebhook 一覧

アプリケーションの受信キー/バリューWebhookを最も古いものから最大20件リストします。各Webhookは書き込むキー、取り込みURL、書き込み済みのlast_used_atを含みます。シークレットはここでは決して返されません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200アプリケーションのキー/バリュー webhook。KVWebhookリスト(application/json)
デフォルト

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

問題 (application/problem+json)
POST/api/applications/{application_id}/kv-webhooks

KVWebhookを作成

受信キー/バリューWebhookを作成します:このアプリケーションの1つのキーに書き込む1つのURLで、外部システム(Zapier、Make、POS、cronジョブ、curl)が1つのHTTP POSTでスクリーンにデータをプッシュします。詳細はPOST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write.を参照してください。キーはまだ存在していなくてもかまいません。

回答はシークレットが表示される唯一の場所です(回転回答と共に):送信システムにすぐに保存してください。サーバーはダイジェストを保持します。アプリケーションは最大20の webhook を持てます(kv_webhook_limit_reached)。kv_webhook.created を追加します。同じ Idempotency-Key での正確な再試行は24時間この同じ回答(シークレット含む)を返します。

認証
projectBearer
リクエスト本文
KVWebhook作成
操作ID
createKVWebhook

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
application_idパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

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

フィールド説明
key(必須、文字列)minLength: 1 maxLength: 256 パターン: "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$"
説明(任意、文字列)リストを読む人向けに送信される内容。トリム済み;認証情報を含んではいけません。maxLength:200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks'

レスポンス

ステータス意味本文とヘッダー
201URLとシークレットとともに作成されました。KVWebhookWithSecret(application/json);ヘッダー:Cache-Control
400invalid_request - 不正なキーまたは資格情報を含む説明があります。問題 (application/problem+json)
404not_found — このプロジェクトにアプリケーションがありません。問題 (application/problem+json)
409kv_webhook_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)
削除/api/applications/{application_id}/kv-webhooks/{webhook_id}

KVWebhook削除

Webhook を削除します。URLは即座に無効になりますが、書き込んだキーは値を保持します。kv_webhook.deleted を追加します。

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

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
application_idパス必須
webhook_idパス必須アプリケーションのキー/バリューWebhookのIDの1つ。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID'

レスポンス

ステータス意味本文とヘッダー
204削除されました。本文なし
404not_found — このアプリケーションに webhook がありません。問題 (application/problem+json)
デフォルト

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

問題 (application/problem+json)
POST/api/applications/{application_id}/kv-webhooks/{webhook_id}/rotate-secret

KVWebhook シークレットを回転

Webhookのシークレットを置き換え、一度だけ新しいものを返します。古いシークレットは即座に無効になります。送信システムを更新してください。kv_webhook.secret_rotatedを追加します。同じIdempotency-Keyでの正確な再試行は24時間この回答(シークレット含む)を返します。

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

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
application_idパス必須
webhook_idパス必須アプリケーションのキー/バリューWebhookのIDの1つ。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/rotate-secret'

レスポンス

ステータス意味本文とヘッダー
200webhook と新しいシークレット。KVWebhookWithSecret(application/json);ヘッダー:Cache-Control
404not_found — このアプリケーションに webhook がありません。問題 (application/problem+json)
デフォルト

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

問題 (application/problem+json)
POST/api/applications/{application_id}/kv-webhooks/{webhook_id}/write

KVWebhookを受信

外部システムが1つのキーの新しい値を投稿するURLです。AuthorizationヘッダーでWebhook固有のシークレットを使って認証します:Bearer <secret>、またはWebhook IDをユーザー名、シークレットをパスワードとするHTTP Basic認証です。URLやクエリ内のシークレットは受け付けません。

不明なWebhook、別のアプリケーションのWebhook、誤ったシークレットはすべて同じ401を返します。最大1MiBの生の本文はWebhookのキーの値となり、Content-Typeヘッダーはcontent_typeになります(ヘッダーがない場合はapplication/octet-stream。1つのメディアタイプでないヘッダーはinvalid_requestです)。

書き込みは If-Match なしの PUT /api/applications/{application_id}/kv/{key} です。値を置き換え、リビジョンを増やし、他の K/V 書き込みと同様に計測とクォータチェックを受け、残高を理由に拒否されることのない課金対象の API リクエスト 1 回として扱われ、kv.updated を追加します。

Idempotency-Key(8〜200文字)は、送信元による1回の書き込みの再試行を24時間重複排除します。同じキーで本文やコンテンツタイプが異なる場合は idempotency_mismatch です。キーがない場合、すべての送信が新しい書き込みになります。応答はキーの新しいメタデータであり、値は返されません。

Webhook あたり毎分最大120回の書き込みです。各書き込みは、組織とキーの書き込みレートにも計上されます(PUT /api/card-data/{key})。

認証
kvWebhookBearer または kvWebhookBasic
リクエスト本文
string
操作ID
receiveKVWebhook

パラメーター

名前送信する必須?説明
application_idパス必須
webhook_idパス必須アプリケーションのキー/バリューWebhookのIDの1つ。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: */*' --data-binary '@request.bin' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/write'

レスポンス

ステータス意味本文とヘッダー
200キーの新しいメタデータ。KVWebhook書き込み結果(application/json);ヘッダー:RateLimit-Policy、RateLimit、Cache-Control
400invalid_request — 本文が 1 MiB を超えているか、Content-Type が単一のメディアタイプでないか、Idempotency-Key が不正です。問題 (application/problem+json)
401認証エラー — 資格情報がないか間違っている、または不明な webhook です。WWW-Authenticate は Bearer と Basic realm を指定します。問題 (application/problem+json)
409idempotency_mismatch — Idempotency-Key が別の本文またはコンテンツタイプに使用されました。問題 (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)