コンテンツへスキップ
APIリファレンス
APIリファレンス

ガードレールアサインメントの一覧取得

認証済み管理キーから参照可能なアサインメントの一覧を取得します。

Markdownを表示

認証済み管理キーから参照可能なアサインメントの一覧を取得します。

エンドポイント

GET /api/v1/guardrail_assignments
ベースURL
https://runapi.ai
API バージョン
v1
認証
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Authorization
アカウント管理者はすべての割り当てを表示できます。管理者以外のユーザーは自分の API キーの割り当てのみ表示できます。
02

リクエスト

JSONボディ

指定されたリクエストの場所にのみ値を送信してください。

クエリパラメータフィールド2件
limitinteger
任意

1ページあたりに返されるアサインメントの最大数。

デフォルト: 20 範囲: 1 - 100
pageinteger
任意

オフセットページ番号。値は1から始まります。

デフォルト: 1 範囲(固定): 1
03

成功レスポンス

HTTP 200

GET /api/v1/guardrail_assignments

JSON 
{
  "guardrail_assignments": [
    {
      "account_user_id": null,
      "api_token_id": "token_123",
      "created_at": "2026-07-27T10:00:00.000Z",
      "guardrail_id": "guardrail_123",
      "id": "guardrail_assignment_123"
    }
  ],
  "pagination": {
    "limit": 20,
    "page": 1,
    "pages": 1,
    "total": 1
  }
}
04

エラーレスポンス (401)

HTTP 401
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Authentication required"
}
05

エラーレスポンス (403)

HTTP 403
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Management API key required"
}
06

エラーレスポンス (400)

HTTP 400
レスポンススキーマ
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "人が読めるエラーメッセージ。",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "人間が読める形式のバリデーションサマリー。",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "公開リクエストフィールドをキーとするバリデーションメッセージ。各フィールドに対して人間が読める文字列の配列が含まれます。",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

レスポンス例

JSON 
{
  "error": "page must be an integer"
}
07

cURLの例

CURL 
curl -X GET https://runapi.ai/api/v1/guardrail_assignments?page=1&limit=20 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY'