OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 6 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
フィードバック：バグと機能リクエスト
バグレポート一覧
呼び出し元プロジェクトのバグレポートを最新順で最大100件返します。他のプロジェクトの提出物は返されません。フィードバックIDで所有するスレッドを読みます。v1にはページネーションカーソルがありません。各提出物はステータスとスタッフ／エージェントの返信（古い順）を含みます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/bugs'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 呼び出し元プロジェクトが所有するバグ報告。 | FeedbackList（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
バグを報告
呼び出し元プロジェクトに対するバグレポートを1件記録します。提出の自身のフィールドは更新または削除できません。同じフィードバックスレッドの返信で修正や追加情報を加えてください。
完全一致する Idempotency-Key の正確な再試行は24時間オリジナルの送信を返し、重複作成しません。異なる本文は idempotency_mismatch を返します。すべての送信は保存前にスクリーニングされます。
本文が 12 文字未満または 3 単語未満の場合は submission_too_short を返します。問題やリクエストを説明しないテキスト（ランダムな文字列やキーボード連打）は submission_unclear を返します。スパム、リンクが多いテキスト、プロンプトインジェクションや悪意あるテキストは submission_rejected を返します。
拒否された送信は保存されず、問題の詳細は送信されたテキストを繰り返さず、同じIdempotency-Keyでの正確な再試行は同じ拒否を返します。
タイトル、本文、コンテキストに認証情報、クッキー、Authorizationヘッダー、完了ノンス、署名URL、オブジェクトキーを絶対に置かないでください。認証情報形状のテキスト（ScreenRigトークン、JWT、ベアラートークン、クラウドおよびAPIキー、秘密鍵）は保存前に[redacted]に置き換えられ、応答にも置き換えテキストが含まれます。
スクリーニングモデルが一時的に利用できない場合、送信は受け入れられバックグラウンドで再スクリーニングされます。1時間に数回の受け入れ後、プロジェクトはsubmission_screening_unavailable（500、Retry-After）となり、同じリクエストを後で再試行します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| タイトル（必須、文字列） | 単一行の要約。先頭と末尾の空白はトリムされ、制御文字は拒否されます。minLength：1 maxLength：120 |
| body（必須、文字列） | 詳細説明。改行とタブのみ制御文字として使用できます。minLength：1 maxLength：4000 |
| context（任意、FeedbackContext） | 閉じた診断エンベロープ。すべてのメンバーはオプションの制約付きスカラーで、ネストは構造的に不可能、未知のメンバーはinvalid_requestで拒否されます。この形状はクライアントが引数値、資格情報、自由形式環境データを永続化できないように存在します。 |
リクエストテンプレートとレスポンス
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/feedback/bugs'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 保存されたバグレポート。同一の冪等リトライは同じ提出を返します。 | FeedbackSubmission（application/json）；ヘッダー：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) |
| 409 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 422 | 安定した 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 |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
機能リクエスト一覧
呼び出し元プロジェクトの機能要望を最新順で最大100件返します。他のプロジェクトの提出物は返されません。フィードバックIDで所有するスレッドを読みます。v1にはページネーションカーソルがありません。各提出物はステータスとスタッフ／エージェントの返信（古い順）を含みます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/features'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 呼び出し元プロジェクトが所有する機能リクエスト。 | FeedbackList（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
機能を依頼
呼び出し元プロジェクトに対する機能リクエストを1件記録します。提出の自身のフィールドは更新または削除できません。同じフィードバックスレッドの返信で修正や追加情報を加えてください。
完全一致する Idempotency-Key の正確な再試行は24時間オリジナルの送信を返し、重複作成しません。異なる本文は idempotency_mismatch を返します。すべての送信は保存前にスクリーニングされます。
本文が 12 文字未満または 3 単語未満の場合は submission_too_short を返します。問題やリクエストを説明しないテキスト（ランダムな文字列やキーボード連打）は submission_unclear を返します。スパム、リンクが多いテキスト、プロンプトインジェクションや悪意あるテキストは submission_rejected を返します。
拒否された送信は保存されず、問題の詳細は送信されたテキストを繰り返さず、同じIdempotency-Keyでの正確な再試行は同じ拒否を返します。
タイトル、本文、コンテキストに認証情報、クッキー、Authorizationヘッダー、完了ノンス、署名URL、オブジェクトキーを絶対に置かないでください。認証情報形状のテキスト（ScreenRigトークン、JWT、ベアラートークン、クラウドおよびAPIキー、秘密鍵）は保存前に[redacted]に置き換えられ、応答にも置き換えテキストが含まれます。
スクリーニングモデルが一時的に利用できない場合、送信は受け入れられバックグラウンドで再スクリーニングされます。1時間に数回の受け入れ後、プロジェクトはsubmission_screening_unavailable（500、Retry-After）となり、同じリクエストを後で再試行します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| タイトル（必須、文字列） | 単一行の要約。先頭と末尾の空白はトリムされ、制御文字は拒否されます。minLength：1 maxLength：120 |
| body（必須、文字列） | 詳細説明。改行とタブのみ制御文字として使用できます。minLength：1 maxLength：4000 |
| context（任意、FeedbackContext） | 閉じた診断エンベロープ。すべてのメンバーはオプションの制約付きスカラーで、ネストは構造的に不可能、未知のメンバーはinvalid_requestで拒否されます。この形状はクライアントが引数値、資格情報、自由形式環境データを永続化できないように存在します。 |
リクエストテンプレートとレスポンス
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/feedback/features'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 保存された機能リクエスト。同一の冪等リトライは同じ提出を返します。 | FeedbackSubmission（application/json）；ヘッダー：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) |
| 409 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 422 | 安定した 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 |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
フィードバックスレッドを取得
所有するフィードバックIDの元のレポートとすべての返信を読み取ります。IDはプロジェクト権限を付与しません。外国または存在しないレポートはnot_foundを返します。返信は信頼されていないプレーンテキストです。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 所有プロジェクトの完全なフィードバックスレッド、最古の返信が最初。 | FeedbackSubmission（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
フィードバックスレッドに返信
所有するフィードバックレポートに返信を追加します。検証済み認証情報が作成者の身元を提供し、呼び出し元は作成者、ステータス、修正バージョンを設定できません。元のレポートと以前の返信は変更されません。返信は waiting_on_user、fixed、declined、duplicate のレポートを再オープンし、「planned」レポートはステータスを保持します。短いフォローアップが許可されます。
認証情報の形状は編集され、インジェクション/スパム安全チェックが適用されます。最大20件の返信、各1～2000文字。返信、ステータス、イベント、再試行の受領は一括コミットされます。正確な再試行は24時間リプレイされ、取り込み制限消費前に、変更されたペイロードはidempotency_mismatchを返します。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| text（必須、文字列） | プレーンテキスト。改行とタブのみ制御文字。minLength: 1 maxLength: 2000 |
リクエストテンプレートとレスポンス
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/feedback/RESOURCE_ID/responses'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | この返信を含むフィードバックスレッドを更新しました。 | FeedbackSubmission（application/json）；ヘッダー：RateLimit-Policy、RateLimit |
| 422 | 安定した 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 |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |