Keys

Create API key

Create a new API key for programmatic access. The raw key value is returned only once — store it securely. Subsequent reads return a redacted prefix only.

post/v1/keys

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/keys
  • Auth: HTTP bearer

Request body

namestring required
mode'live' | 'test'
scopesstring[]

Response

API key created

idstring required
keystring required

Full key — only returned on creation.

namestring required
mode'live' | 'test' required
scopesstring[] required
created_atstring date-time required

Example response

{
  "key": "bg_live_…"
}

Changes

No recorded changes to this operation across all 1 revision of this API.