Saltar al contenido
Referencia de API
Referencia de API

Crear una asignación de guardarraíl

Asignar una protección a una clave API estándar, un miembro de la cuenta o un presupuesto compartido por etiqueta.

Ver Markdown

Asignar una protección a una clave API estándar, un miembro de la cuenta o un presupuesto compartido por etiqueta.

Endpoint

POST /api/v1/guardrail_assignments
URL base
https://runapi.ai
Versión de la API
v1
Autenticación
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorización
Los administradores de cuenta pueden asignar cualquier destino elegible. Los usuarios no administradores solo pueden asignar sus propias Claves de API estándar.
02

Solicitud

Cuerpo JSON

Envíe valores únicamente en la ubicación de solicitud indicada.

Cuerpo JSON4 campos
account_user_idstring
Opcional

ID de prefijo del miembro de la cuenta. Este destino requiere un administrador de cuenta.

api_token_idstring
Opcional

ID con prefijo de clave API estándar. Proporcione exactamente uno de api_token_id, account_user_id o tag.

guardrail_idstring
Obligatorio

ID de prefijo de Guardrail.

tagstring
Opcional

Etiqueta key:value que distingue mayúsculas para un presupuesto compartido. Requiere un administrador y una protección positiva en modo block. Proporcione exactamente un destino.

03

Respuesta de éxito

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

Respuesta de error (401)

HTTP 401
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

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

Respuesta de error (403)

HTTP 403
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

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

Respuesta de error (400)

HTTP 400
Esquema de respuesta
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Mensaje de error legible por personas.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Resumen de validación legible por personas.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Mensajes de validación con clave por campo de solicitud público, con un array de cadenas legibles por personas para cada campo.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Ejemplo de respuesta

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

Respuesta de error (403)

HTTP 403
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON 
{
  "error": "Forbidden"
}
08

Respuesta de error (404)

HTTP 404
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

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

Respuesta de error (422)

HTTP 422
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Resumen de validación legible por personas.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Mensajes de validación con clave por campo de solicitud público, con un array de cadenas legibles por personas para cada campo.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

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

Ejemplo de 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"}'