Pular para o conteúdo
Referência de API
Referência de API

Criar um guardrail

Crie um modelo, provedor e política de orçamento reutilizáveis.

Ver Markdown

Crie um modelo, provedor e política de orçamento reutilizáveis.

Endpoint

POST /api/v1/guardrails
URL base
https://runapi.ai
Versão da API
v1
Autenticação
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorização
Requer uma chave de API de gerenciamento de administrador de conta.
02

Solicitação

Corpo JSON

Envie valores apenas no local de requisição listado.

Corpo JSON12 campos
alert_threshold_percentinteger
Opcional

Porcentagem do limite de alerta do orçamento.

Padrão: 80 Intervalo: 1 - 100
allowed_modelsarray | null
Opcional

Lista de permissões de modelos.

allowed_providersarray | null
Opcional

Lista de permissões de nomes de provedores.

blocked_modelsarray | null
Opcional

Lista de bloqueio de modelos, que tem precedência sobre a lista de permissões.

blocked_providersarray | null
Opcional

Lista de bloqueio de nomes de provedores.

credit_limit_behaviorstring
Opcional

Modo de aplicação do orçamento. Atribuições por etiqueta exigem block.

Valores permitidos: block, alert_only Padrão: block
credit_limit_centsinteger | null
Opcional

Limite total de gastos em centavos de USD.

credit_limit_reset_intervalstring | null
Opcional

Periodicidade do limite total. Null indica vitalício quando há um valor definido.

Valores permitidos: daily, weekly, monthly
descriptionstring
Opcional

Descrição opcional em formato livre.

enabledboolean
Opcional

Se o guardrail é aplicado.

Padrão: true
model_budgetsarray | null
Opcional

Regras de orçamento por modelo.

namestring
Obrigatório

Nome do guardrail único dentro da conta.

03

Resposta de sucesso

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

Resposta de erro (401)

HTTP 401
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Resposta de erro (403)

HTTP 403
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Resposta de erro (403)

HTTP 403
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Resposta de erro (400)

HTTP 400
Esquema de resposta
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Mensagem de erro legível por humanos.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Resumo de validação legível por humanos.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Mensagens de validação com chaves por campo de requisição público, com um array de strings legíveis por humanos para cada campo.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Exemplo de resposta

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

Resposta de erro (422)

HTTP 422
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Resumo de validação legível por humanos.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Mensagens de validação com chaves por campo de requisição público, com um array de strings legíveis por humanos para cada campo.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Exemplo de cURL

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