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

Atualizar uma Chave de API

Atualize uma Chave de API Padrão existente e recupere seu resumo de uso atual.

Ver Markdown

Atualize uma Chave de API Padrão existente e recupere seu resumo de uso atual.

Endpoint

PATCH /api/v1/keys/:id
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 e permite apenas chaves pertencentes ao seu usuário.
02

Solicitação

Corpo JSON

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

Corpo JSON6 campos
allowed_modelsarray | null
Opcional

Lista de permissões de modelos substituta; null ou um array vazio a limpa.

credit_limit_centsinteger | null
Opcional

Limite de gastos em centavos de USD; null limpa o limite e o intervalo de redefinição.

credit_limit_reset_intervalstring | null
Opcional

Cadência de redefinição para o limite de gastos.

Valores permitidos: daily, weekly, monthly
credit_limit_windowsobject
Opcional

Limites de gastos contínuos substitutos com chaves 1h, 1d ou 7d; um objeto vazio remove todos os limites contínuos.

enabledboolean
Opcional

Se as requisições que usam esta chave são aceitas.

namestring
Opcional

Nome amigável substituto para a chave de API.

Parâmetros de caminho1 campo
idstring
Obrigatório

ID de prefixo da Chave de API, por exemplo token_123.

03

Resposta de sucesso

HTTP 200

PATCH /api/v1/keys/:id

JSON 
{
  "allowed_models": [
    "gpt-5.4"
  ],
  "created_at": "2026-07-27T10:00:00.000Z",
  "credit_limit_cents": 1000,
  "credit_limit_reset_interval": "daily",
  "credit_limit_windows": {},
  "credit_usage_cents_by_model": {
    "gpt-5.4": 250
  },
  "credit_usage_cents_this_month": 250,
  "credit_usage_cents_this_week": 100,
  "credit_usage_cents_today": 25,
  "credit_usage_cents_total": 250,
  "enabled": true,
  "guardrail_id": "guardrail_123",
  "id": "token_123",
  "last_used_at": null,
  "masked_token": "runapi_abc...wxyz",
  "name": "Production primary"
}
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 (404)

HTTP 404
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": "Resource not found"
}
09

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

Exemplo de cURL

CURL 
curl -X PATCH https://runapi.ai/api/v1/keys/token_123 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production primary","enabled":true,"credit_limit_windows":{}}'