Vai al contenuto
Riferimento API
Riferimento API

Aggiorna un guardrail

Sostituisce i campi forniti per tutte le assegnazioni che usano questa politica condivisa. I campi omessi restano invariati.

Visualizza Markdown

Sostituisce i campi forniti per tutte le assegnazioni che usano questa politica condivisa. I campi omessi restano invariati.

Endpoint

PATCH /api/v1/guardrails/:id
URL di base
https://runapi.ai
Versione API
v1
Autenticazione
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorizzazione
Richiede una Chiave API di gestione con ruolo account-admin.
02

Richiesta

Corpo JSON

Invia i valori solo nella posizione di richiesta elencata.

Corpo JSON12 campi
alert_threshold_percentinteger
Opzionale

Percentuale della soglia di avviso del budget.

Predefinito: 80 Intervallo: 1 - 100
allowed_modelsarray | null
Opzionale

Allowlist dei modelli sostitutiva.

allowed_providersarray | null
Opzionale

Allowlist del nome del provider sostitutiva.

blocked_modelsarray | null
Opzionale

Blocklist dei modelli sostitutiva.

blocked_providersarray | null
Opzionale

Blocklist del nome del provider sostitutiva.

credit_limit_behaviorstring
Opzionale

Modalità di applicazione del budget. Le assegnazioni per tag richiedono block.

Valori consentiti: block, alert_only Predefinito: block
credit_limit_centsinteger | null
Opzionale

Tetto di spesa totale in centesimi di USD.

credit_limit_reset_intervalstring | null
Opzionale

Periodicità del limite totale. Null indica un limite permanente se è impostato un importo.

Valori consentiti: daily, weekly, monthly
descriptionstring
Opzionale

Descrizione in formato libero sostitutiva.

enabledboolean
Opzionale

Se il guardrail è applicato.

model_budgetsarray | null
Opzionale

Regole di budget per modello sostitutive.

namestring
Opzionale

Nome del guardrail sostitutivo.

Parametri del percorso1 campo
idstring
Obbligatorio

ID prefisso del Guardrail, ad esempio guardrail_abc123.

03

Risposta di successo

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

Risposta di errore (401)

HTTP 401
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (403)

HTTP 403
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (403)

HTTP 403
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (400)

HTTP 400
Schema della risposta
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Messaggio di errore leggibile.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Riepilogo di convalida leggibile dall'utente.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Messaggi di convalida con chiave per campo della richiesta pubblica, con un array di stringhe leggibili dall'utente per ogni campo.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Esempio di risposta

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

Risposta di errore (404)

HTTP 404
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (422)

HTTP 422
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Riepilogo di convalida leggibile dall'utente.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Messaggi di convalida con chiave per campo della richiesta pubblica, con un array di stringhe leggibili dall'utente per ogni campo.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

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