v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-06181217.3 KB

API keys

Create an API key

Creates a new scoped key for trusted integrations and MCP clients. This endpoint accepts web session tokens only; API keys cannot create other API keys. The plaintext bp_ key is returned once; store it immediately.

post/api/api-keys

Request body

namestring required

scopesApiKeyScope[]

Scopes granted to the new key. Send explicit least-privilege scopes for API-created keys.

Response

Created API key including one-time plaintext key.

idstring uuid

namestring

scopesApiKeyScope[]

createdAtstring date-time

lastUsedAtstring date-time nullable

revokedAtstring date-time nullable

keystring

Example response

{
  "key": "bp_YOUR_API_KEY"
}