Zum Inhalt springen
API-Referenz
API-Referenz

Eine Guardrail erstellen

Erstellen Sie ein wiederverwendbares Modell, einen Anbieter und eine Budget-Richtlinie.

Markdown anzeigen

Erstellen Sie ein wiederverwendbares Modell, einen Anbieter und eine Budget-Richtlinie.

Endpunkt

POST /api/v1/guardrails
Basis-URL
https://runapi.ai
API-Version
v1
Authentifizierung
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisierung
Erfordert einen Management-API-Schlüssel mit Kontoadministrator-Rechten.
02

Anfrage

JSON-Body

Werte nur am angegebenen Anfrage-Speicherort senden.

JSON-Body12 Felder
alert_threshold_percentinteger
Optional

Prozentwert der Budget-Warnschwelle.

Standard: 80 Bereich: 1 - 100
allowed_modelsarray | null
Optional

Modell-Zulassungsliste.

allowed_providersarray | null
Optional

Allowlist für Anbieternamen.

blocked_modelsarray | null
Optional

Modell-Sperrliste, die Vorrang vor der Zulassungsliste hat.

blocked_providersarray | null
Optional

Blocklist für Anbieternamen.

credit_limit_behaviorstring
Optional

Durchsetzungsmodus des Budgets. Tag-Zuordnungen erfordern block.

Zulässige Werte: block, alert_only Standard: block
credit_limit_centsinteger | null
Optional

Gesamtes Ausgabenlimit in USD-Cent.

credit_limit_reset_intervalstring | null
Optional

Zeitraum des Gesamtausgabenlimits. Null bedeutet dauerhaft, wenn ein Betrag festgelegt ist.

Zulässige Werte: daily, weekly, monthly
descriptionstring
Optional

Optionale Freitext-Beschreibung.

enabledboolean
Optional

Ob das Guardrail durchgesetzt wird.

Standard: true
model_budgetsarray | null
Optional

Modellspezifische Budget-Regeln.

namestring
Erforderlich

Guardrail-Name, eindeutig innerhalb des Kontos.

03

Erfolgsantwort

HTTP 201

POST /api/v1/guardrails

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": true,
  "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

Fehlerantwort (401)

HTTP 401
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

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

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

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

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

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

Fehlerantwort (400)

HTTP 400
Antwort-Schema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Für Menschen lesbare Fehlermeldung.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Menschenlesbare Validierungszusammenfassung.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validierungsmeldungen nach öffentlichem Anforderungsfeld gegliedert, mit einem Array menschenlesbarer Zeichenketten für jedes Feld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Antwortbeispiel

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

Fehlerantwort (422)

HTTP 422
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Menschenlesbare Validierungszusammenfassung.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Validierungsmeldungen nach öffentlichem Anforderungsfeld gegliedert, mit einem Array menschenlesbarer Zeichenketten für jedes Feld.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

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

cURL-Beispiel

CURL 
curl -X POST https://runapi.ai/api/v1/guardrails \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production budget","description":"Production policy","enabled":true,"credit_limit_cents":50000,"credit_limit_reset_interval":"monthly","credit_limit_behavior":"block","alert_threshold_percent":80,"allowed_models":["gpt-5.4"],"model_budgets":[{"match_mode":"include","models":["gpt-5.4"],"credit_limit_cents":10000,"credit_limit_reset_interval":"monthly"}]}'