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

تحديث حارس

استبدال الحقول المقدمة لجميع التعيينات التي تستخدم هذه السياسة المشتركة. تبقى الحقول المحذوفة من الطلب دون تغيير.

عرض Markdown

استبدال الحقول المقدمة لجميع التعيينات التي تستخدم هذه السياسة المشتركة. تبقى الحقول المحذوفة من الطلب دون تغيير.

نقطة النهاية

PATCH /api/v1/guardrails/:id
عنوان URL الأساسي
https://runapi.ai
إصدار API
v1
المصادقة
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
التفويض
يتطلب مفتاح Management API لمسؤول الحساب.
02

الطلب

نص JSON

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

جسم JSON12 حقل
alert_threshold_percentinteger
اختياري

النسبة المئوية لعتبة تنبيه الميزانية.

القيمة الافتراضية: 80 نطاق: 1 - 100
allowed_modelsarray | null
اختياري

قائمة السماح بالنماذج البديلة.

allowed_providersarray | null
اختياري

قائمة السماح بأسماء المزوّدين البديلة.

blocked_modelsarray | null
اختياري

قائمة الحظر بالنماذج البديلة.

blocked_providersarray | null
اختياري

قائمة الحظر بأسماء المزوّدين البديلة.

credit_limit_behaviorstring
اختياري

وضع تطبيق الميزانية. تتطلب تعيينات الوسوم block.

القيم المسموح بها: block, alert_only القيمة الافتراضية: block
credit_limit_centsinteger | null
اختياري

إجمالي حد الإنفاق بسنتات الدولار الأمريكي.

credit_limit_reset_intervalstring | null
اختياري

دورية إعادة تعيين حد الإنفاق الإجمالي. تعني Null مدى الحياة عند تحديد مبلغ.

القيم المسموح بها: daily, weekly, monthly
descriptionstring
اختياري

وصف بديل بصياغة حرة.

enabledboolean
اختياري

ما إذا كان يتم تطبيق الحاجز الواقي.

model_budgetsarray | null
اختياري

قواعد الميزانية البديلة لكل نموذج.

namestring
اختياري

اسم بديل للضابط الوقائي.

معاملات المسارحقل واحد
idstring
مطلوب

معرّف بادئة Guardrail، على سبيل المثال guardrail_abc123.

03

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

HTTP 200

PATCH /api/v1/guardrails/:id

JSON 
{
  "alert_threshold_percent": 80,
  "allowed_models": [
    "gpt-5.4"
  ],
  "allowed_providers": [],
  "assignment_count": 1,
  "blocked_models": [],
  "blocked_providers": [],
  "created_at": "2026-07-27T10:00:00.000Z",
  "credit_limit_behavior": "block",
  "credit_limit_cents": 50000,
  "credit_limit_reset_interval": "monthly",
  "description": "Production policy",
  "enabled": false,
  "id": "guardrail_123",
  "model_budgets": [
    {
      "credit_limit_cents": 10000,
      "credit_limit_reset_interval": "monthly",
      "match_mode": "include",
      "models": [
        "gpt-5.4"
      ]
    }
  ],
  "name": "Production budget"
}
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

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

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

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

JSON 
{
  "error": "Account admin required"
}
07

استجابة الخطأ (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"
}
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 PATCH https://runapi.ai/api/v1/guardrails/guardrail_123 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":false}'