Saltar al contenido principal

Base URL

Todas las rutas de la API cuelgan de /v1. Si tu organización tiene una instalación propia, usá la URL que te dieron.

Mandar la clave

Toda ruta de /v1 pide una clave de API. Va en cualquiera de estos dos headers:
string
Bearer bkg_live_…. La forma estándar, la que usan la mayoría de los clientes HTTP y el MCP.
string
bkg_live_…, sin prefijo. Equivalente al anterior.
Guardá la clave en una variable de entorno o en un gestor de secretos, nunca en el código. Cómo crearla y revocarla: Claves de API.

Qué ve cada clave

Una clave de una persona con rol viewer, o una clave de la organización marcada read_only, solo lee: consulta todo GET y los POST que no guardan nada. Ver Cuentas y organizaciones.

Headers opcionales

string
El caso en el que estás trabajando (case_…). Las consultas que lo llevan quedan en la cadena de custodia del caso y las labels que cargues valen solo dentro de él. Si nombra un caso que no ves, la respuesta es 400 con error: "case_unavailable" y la consulta no se hace.

Respuestas de autenticación