تخطَّ إلى المحتوى
مرجع API
مرجع API

إنشاء تعيين حارس

إرفاق سياسة حماية بمفتاح API قياسي أو عضو حساب أو ميزانية وسم مشتركة.

عرض Markdown

إرفاق سياسة حماية بمفتاح API قياسي أو عضو حساب أو ميزانية وسم مشتركة.

نقطة النهاية

POST /api/v1/guardrail_assignments
عنوان URL الأساسي
https://runapi.ai
إصدار API
v1
المصادقة
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
التفويض
يمكن لمسؤولي الحساب تعيين أي هدف مؤهل. لا يمكن للمستخدمين غير المسؤولين تعيين سوى مفاتيح API القياسية الخاصة بهم.
02

الطلب

نص JSON

أرسل القيم فقط في موقع الطلب المُدرج.

جسم JSON4 حقل
account_user_idstring
اختياري

معرّف بادئة عضو الحساب. يتطلب هذا الهدف مسؤول حساب.

api_token_idstring
اختياري

معرّف مفتاح API القياسي ذو البادئة. حدد واحدًا بالضبط من api_token_id أو account_user_id أو tag.

guardrail_idstring
مطلوب

معرّف بادئة Guardrail.

tagstring
اختياري

وسم key:value حساس لحالة الأحرف لميزانية مشتركة. يتطلب مسؤول حساب وسياسة حماية بحد موجب في وضع block. حدد هدفًا واحدًا بالضبط.

03

استجابة النجاح

HTTP 201

POST /api/v1/guardrail_assignments

JSON 
{
  "account_user_id": null,
  "api_token_id": null,
  "created_at": "2026-07-27T10:00:00.000Z",
  "guardrail_id": "guardrail_123",
  "id": "guardrail_assignment_123",
  "tag": "dept:ml"
}
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

استجابة الخطأ (403)

HTTP 403
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

JSON 
{
  "error": "Forbidden"
}
08

استجابة الخطأ (404)

HTTP 404
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

JSON 
{
  "error": "Resource not found"
}
09

استجابة الخطأ (422)

HTTP 422
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "ملخص التحقق القابل للقراءة البشرية.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "رسائل التحقق مفتاحها حقل الطلب العام، مع مصفوفة من السلاسل القابلة للقراءة البشرية لكل حقل.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

JSON 
{
  "error": "Validation failed",
  "errors": {
    "base": [
      "Validation failed"
    ]
  }
}
10

مثال cURL

CURL 
curl -X POST https://runapi.ai/api/v1/guardrail_assignments \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"guardrail_id":"guardrail_123","tag":"dept:ml"}'