Naar inhoud springen
API-referentie
API-referentie

Een guardrail bijwerken

Vervang de opgegeven velden voor alle koppelingen die dit gedeelde beleid gebruiken. Weggelaten velden blijven ongewijzigd.

Markdown bekijken

Vervang de opgegeven velden voor alle koppelingen die dit gedeelde beleid gebruiken. Weggelaten velden blijven ongewijzigd.

Eindpunt

PATCH /api/v1/guardrails/:id
Basis-URL
https://runapi.ai
API-versie
v1
Authenticatie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisatie
Vereist een Management API-sleutel met accountbeheerdersrechten.
02

Verzoek

JSON-body

Stuur waarden alleen op de vermelde verzoeklocatie.

JSON-body12 velden
alert_threshold_percentinteger
Optioneel

Percentage van de budgetwaarschuwingsdrempel.

Standaard: 80 Bereik: 1 - 100
allowed_modelsarray | null
Optioneel

Vervangende toegestane modellenlijst.

allowed_providersarray | null
Optioneel

Vervangende toegestane lijst van providernamen.

blocked_modelsarray | null
Optioneel

Vervangende geblokkeerde modellenlijst.

blocked_providersarray | null
Optioneel

Vervangende geblokkeerde lijst van providernamen.

credit_limit_behaviorstring
Optioneel

Handhavingsmodus van het budget. Tagkoppelingen vereisen block.

Toegestane waarden: block, alert_only Standaard: block
credit_limit_centsinteger | null
Optioneel

Totale bestedingslimiet in USD-centen.

credit_limit_reset_intervalstring | null
Optioneel

Periode van de totale uitgavenlimiet. Null betekent levenslang als een bedrag is ingesteld.

Toegestane waarden: daily, weekly, monthly
descriptionstring
Optioneel

Vervangende vrije-tekst beschrijving.

enabledboolean
Optioneel

Of de beveiligingsregel wordt gehandhaafd.

model_budgetsarray | null
Optioneel

Vervangende budgetregels per model.

namestring
Optioneel

Vervangende naam voor de beveiligingsrichtlijn.

Padparameters1 veld
idstring
Verplicht

Prefix-ID van de guardrail, bijvoorbeeld guardrail_abc123.

03

Succesvol antwoord

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

Foutrespons (401)

HTTP 401
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (403)

HTTP 403
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (403)

HTTP 403
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (400)

HTTP 400
Responsschema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Leesbare foutmelding.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Leesbare validatiesamenvatting.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Responsvoorbeeld

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

Foutrespons (404)

HTTP 404
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (422)

HTTP 422
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare validatiesamenvatting.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

cURL-voorbeeld

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}'