Platform API
Manage keys, read usage, set a spend cap, export or delete your account, work with organizations, settings and audit logs, and send integration notifications.
On this page
The Platform API manages your BreachLine account and organization. It lives under https://api.breachline.io/api/v1/ and accepts the same credentials as the LLM API.
API keysCreate, list, rotate and revoke keys.Usage and spend capTotals, activity logs, budget burn and your spend cap.Account and privacyProfile, data export, account deletion and erasure requests.OrganizationsOrganizations, members and invitations.Settings and audit logsNotification preferences and the audit trail.IntegrationsIntegration status, Slack messages and the Jira configuration.
Permissions
Two kinds of permission apply on the Platform API:
- Key scopes gate key management (
keys:read,keys:revoke). - Member scopes, given to each person by an organization owner, gate organization data, for example
usage:read,settings:write,audit:readandintegrations:notify. A key acts with the member scopes of the person who owns it.
Some operations need an interactive session and refuse API keys: creating or rotating keys, exporting your data and deleting your account.
The public surface
The public API is the endpoints in this section, the OpenAI-compatible API and the Anthropic-compatible API. The API reference lists every one of them.