Pular para o conteúdo
Guias
Guias

Início rápido

Crie e governe chaves de API padrão e proteções com uma chave de gerenciamento RunAPI.

O Gerenciamento de Plataforma permite que administradores de conta criem, inspecionem, atualizem e revoguem chaves de API padrão e guardrails sem usar o painel para cada alteração.

Criar uma chave de gerenciamento

Siga o Guia de Autenticação para fazer login, depois abra a página de Chaves de Gerenciamento e crie uma chave de gerenciamento. Armazene-a separadamente das chaves de aplicação padrão. Envie-a como um token bearer somente para endpoints de Platform Management.

HTTP
Authorization: Bearer YOUR_MANAGEMENT_KEY

Uma Chave de API padrão não pode chamar endpoints de gerenciamento de chaves ou guardrails. Uma chave de gerenciamento válida ainda pode receber 403 Forbidden quando seu proprietário não possuir mais a função de conta necessária.

Listar Chaves de API padrão

Use GET /api/v1/keys para inspecionar as chaves visíveis à conta da chave de gerenciamento:

SHELL
curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

Use os identificadores públicos retornados para requisições posteriores de recuperação, atualização, revogação ou atribuição de guardrail. Nunca infira acesso a partir do nome de uma chave ou de um token mascarado.

Criar e rotacionar uma chave

Crie uma chave de aplicação com POST /api/v1/keys. O segredo completo é retornado apenas na resposta de criação, portanto persista-o no seu gerenciador de segredos antes de descartar essa resposta. A rotação deve criar uma substituição, implantá-la na aplicação, verificar o tráfego e revogar a chave antiga.

SHELL
curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows aceita qualquer combinação de limites de gastos contínuos 1h, 1d e 7d. Se qualquer janela configurada for esgotada, as chamadas com essa chave retornam 429 Too Many Requests até que o uso saia da janela. Envie um objeto vazio ao atualizar uma chave para remover todos os limites contínuos.

Aplicar guardrails

Guardrails são políticas de conta reutilizáveis para controles de modelo, provedor e gastos. Gerencie as políticas em /api/v1/guardrails, depois use /api/v1/guardrail_assignments para vinculá-las ou removê-las. Trate um assignment rejeitado como uma falha de política ou propriedade em vez de continuar silenciosamente sem o guardrail.

Tratar erros de gerenciamento

  • 401 Unauthorized significa que a credencial está ausente, malformada, revogada ou inválida.
  • 403 Forbidden significa que a classe de credencial ou função de conta não pode realizar a operação.
  • 404 Not Found significa que o recurso solicitado não está visível para a conta autenticada.
  • 422 Unprocessable Content significa que um ou mais valores enviados violam uma regra de recurso.