API リファレンス

サービスと機能 API

サービスのメタデータ、機能、ドキュメント検索

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

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

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

サービスのメタデータ、機能、ドキュメント検索

GET/.health

Health を取得

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

レスポンス

ステータス意味本文とヘッダー
200生存中HealthResponse(application/json)
GET/.ready

レディネスを取得

サービス準備完了。ドレイン中のホストは Retry-After: 1 を伴う 421 server_draining を返します。必須依存関係の失敗は Retry-After を伴う 500 not_ready を返します。このリリースに適合しないライブデータベーススキーマ(2分以上異なるか欠落したインデックス)は Retry-After なしの 500 schema_incompatible を返します:待機しても解消しません。

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

レスポンス

ステータス意味本文とヘッダー
200準備完了ReadyResponse(application/json)
421

Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式(RuntimeProblem)。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

ランタイム問題(application/problem+json)
500

Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式(RuntimeProblem)。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

ランタイム問題(application/problem+json)
GET/.version

バージョンを取得

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

レスポンス

ステータス意味本文とヘッダー
200バージョンVersionResponse(application/json)
GET/api/capabilities

機能を取得

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

レスポンス

ステータス意味本文とヘッダー
200機能とアーカイブの制限機能(application/json)
GET/api/docs/search

公式ドキュメントを検索

公式の screenRIG ドキュメント(screenrig.ai/docs のページ、問題タイプ、料金、その他のお客様向けページ)を検索し、一致度の高い順にセクションを最大 limit 件(既定は 8)返します。公開で、認証情報は不要、呼び出しに課金されることはありません。

ヒットの url はそのページです(ページがフラグメントを持つ場合はセクションのフラグメント付き)。section は見出し、snippet は一致箇所の前後のテキストです。ページまたはセクションは getDocsPage で読みます。クライアント IP ごとに毎分 120 リクエストに制限されます(IPv6 は /64 単位)。

コーパスは 15 分ごとに再読み込みされます。最初の読み込み前は、ルートは 500 not_ready を Retry-After 付きで返します。

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

パラメーター

名前送信する必須?説明
qクエリ必須単語、コマンドまたはフラグ、あるいはエラーコード。1~200文字。
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET 'https://api.screenrig.ai/api/docs/search?q=Q'

レスポンス

ステータス意味本文とヘッダー
200一致したセクションを、一致度の高い順に返します。一致するものがない場合は空です。DocsSearchResponse(application/json);ヘッダー:RateLimit-Policy、RateLimit
デフォルト

安定した 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
GET/api/docs/page

公式ドキュメントのページまたはセクションを読む

公式ドキュメントのページを Markdown で返します。section を指定すると、そのページの 1 つのセクションを下位セクションとともに返します。url は searchDocs が返すページのアドレス、その .md 形式、またはパスのみで、#fragment の有無は問いません(section が指定されていない場合、フラグメントがセクションを指します)。section はページの見出しまたはアンカー、あるいは見出しの一部です。

セクションは 48 KiB 以内の行末で切り詰められ、truncated true になります。48 KiB を超えるページ全体は、冒頭部分とアウトラインを truncated true で返します。sections は次に読む見出し(ページの見出し、またはセクション自身の下位見出し)を一覧にします。存在しないページとセクションは 404 not_found を返します。

公開で、課金されることはなく、searchDocs と同じくクライアント IP ごとに毎分 120 リクエストに制限されます。

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

パラメーター

名前送信する必須?説明
URLクエリ必須ページのアドレス。1~500文字。
sectionクエリオプションページの見出しまたはアンカー。最大200文字。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET 'https://api.screenrig.ai/api/docs/page?url=URL'

レスポンス

ステータス意味本文とヘッダー
200Markdown 形式のページまたはセクション。DocsPage(application/json);ヘッダー:RateLimit-Policy、RateLimit
デフォルト

安定した 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