Aller au contenu
Référence API
Référence API

Créer une affectation de guardrail

Associer un garde-fou à une clé API standard, un membre du compte ou un budget partagé par étiquette.

Voir en Markdown

Associer un garde-fou à une clé API standard, un membre du compte ou un budget partagé par étiquette.

Point de terminaison

POST /api/v1/guardrail_assignments
URL de base
https://runapi.ai
Version de l'API
v1
Authentification
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisation
Les administrateurs de compte peuvent affecter n'importe quelle cible éligible. Les utilisateurs non administrateurs ne peuvent affecter que leurs propres clés API Standard.
02

Requête

Corps JSON

Envoyez les valeurs uniquement à l'emplacement de requête indiqué.

Corps JSON4 champs
account_user_idstring
Optionnel

Identifiant de préfixe de membre du compte. Cette cible nécessite un administrateur de compte.

api_token_idstring
Optionnel

Identifiant préfixé de clé API standard. Indiquez exactement un champ parmi api_token_id, account_user_id ou tag.

guardrail_idstring
Requis

Préfixe d'identifiant du guardrail.

tagstring
Optionnel

Étiquette key:value sensible à la casse pour un budget partagé. Nécessite un administrateur du compte et un garde-fou positif en mode block. Indiquez exactement une cible.

03

Réponse de succès

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

Réponse d'erreur (401)

HTTP 401
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (403)

HTTP 403
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (400)

HTTP 400
Schéma de réponse
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Message d'erreur lisible par l'humain.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Résumé de validation lisible par l'humain.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Messages de validation indexés par champ de requête public, avec un tableau de chaînes lisibles par l'humain pour chaque champ.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Exemple de réponse

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

Réponse d'erreur (403)

HTTP 403
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

JSON 
{
  "error": "Forbidden"
}
08

Réponse d'erreur (404)

HTTP 404
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (422)

HTTP 422
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Résumé de validation lisible par l'humain.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Messages de validation indexés par champ de requête public, avec un tableau de chaînes lisibles par l'humain pour chaque champ.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

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