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

Criar uma Chave de API

Crie uma Chave de API padrão. Salve a chave em texto simples retornada por esta operação, pois ela é exibida apenas uma vez.

Ver Markdown

Crie uma Chave de API padrão. Salve a chave em texto simples retornada por esta operação, pois ela é exibida apenas uma vez.

Endpoint

POST /api/v1/keys
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. A nova chave de API padrão pertence ao chamador.
02

Solicitação

Corpo JSON

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

Corpo JSON8 campos
allowed_modelsarray | null
Opcional

Lista de permissões opcional de identificadores de modelos.

credit_limit_centsinteger | null
Opcional

Limite de gastos opcional em centavos de USD.

credit_limit_reset_intervalstring | null
Opcional

Cadência opcional de reinicialização do limite de gastos da chave.

Valores permitidos: daily, weekly, monthly
credit_limit_windowsobject
Opcional

Limites de gastos contínuos com chaves 1h, 1d ou 7d; cada valor contém um limit_cents inteiro positivo.

enabledboolean
Opcional

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

Padrão: true
guardrail_idstring
Opcional

ID de prefixo opcional do guardrail a ser vinculado na criação.

namestring
Opcional

Nome amigável para a Chave de API.

tagsarray
Opcional

Strings key:value completas (chave de 1–32 caracteres, valor de 1–64, sem espaços em branco; no máximo 20 tags). Uma usage:developer ou usage:service; padrão usage:service na criação. Um único ambiente opcional: env:production, env:staging ou env:dev.

03

Resposta de sucesso

HTTP 201

POST /api/v1/keys

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": {
    "1d": {
      "limit_cents": 500
    },
    "1h": {
      "limit_cents": 100
    },
    "7d": {
      "limit_cents": 2000
    }
  },
  "enabled": true,
  "guardrail_id": "guardrail_123",
  "id": "token_123",
  "key": "runapi_plaintext_example",
  "last_used_at": null,
  "masked_token": "runapi_abc...wxyz",
  "name": "Production",
  "tags": [
    "usage:service",
    "env:production",
    "dept:ml"
  ]
}
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/keys \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production","tags":["env:production","dept:ml"],"credit_limit_cents":1000,"credit_limit_reset_interval":"daily","credit_limit_windows":{"1h":{"limit_cents":100},"1d":{"limit_cents":500},"7d":{"limit_cents":2000}},"allowed_models":["gpt-5.4"],"guardrail_id":"guardrail_123"}'