API reference 2026-11-11

API version

2026-11-11 (latest)next (preview)

CurrentDownload OpenAPI (JSON)Versioning

This reference is static and read-only. It has no Try it feature and sends no requests, so API keys are never entered on this site. Call the API from your own environment; see the quickstart.

LLM API

Chat

OpenAI-compatible chat completions.

• POST /api/v1/llm/v1/chat/completions Create a chat completion

Responses

OpenAI-compatible Responses API, with optional stored threads.

• POST /api/v1/llm/v1/responses Create a response
• GET /api/v1/llm/v1/responses/{response_id} Retrieve a stored response
• DELETE /api/v1/llm/v1/responses/{response_id} Delete a stored response

MessagesBeta

Anthropic-compatible Messages API. Beta.

• POST /api/v1/llm/v1/messages Create a message (Anthropic-compatible)
• POST /api/v1/llm/v1/messages/count_tokens Count tokens (estimate)

Models

The public Nebula model catalog with GBP prices.

• GET /api/v1/llm/v1/models List models

Embeddings

OpenAI-compatible text embeddings.

• POST /api/v1/llm/v1/embeddings Create embeddings

Rerank

Cohere-compatible document reranking.

• POST /api/v1/llm/v1/rerank Rerank documents

Batches

Asynchronous bulk chat completions and their JSONL input files.

• GET /api/v1/llm/v1/batches List batches
• POST /api/v1/llm/v1/batches Create a batch
• GET /api/v1/llm/v1/batches/{batch_id} Retrieve a batch
• POST /api/v1/llm/v1/batches/{batch_id}/cancel Cancel a batch
• GET /api/v1/llm/v1/batches/{batch_id}/results Get batch results
• POST /api/v1/llm/v1/files Upload a batch input file
• GET /api/v1/llm/v1/files/{file_id}/content Download file content

Platform API

API keys

Create, list, rotate and revoke bl_live_ API keys.

• POST /api/v1/keys/create Create an API key
• GET /api/v1/keys/list List API keys
• DELETE /api/v1/keys/{key_id} Revoke an API key
• POST /api/v1/keys/refresh/{key_id} Rotate an API key

Usage

Token usage, the activity log and the self-service spend cap.

• GET /api/v1/usage/me Get your usage
• GET /api/v1/usage/me/logs List your recent requests
• GET /api/v1/usage/me/budget Get your budget burn
• GET /api/v1/usage/me/budget/cap Get your spend cap
• PUT /api/v1/usage/me/budget/cap Set your spend cap
• DELETE /api/v1/usage/me/budget/cap Remove your spend cap
• GET /api/v1/usage/org/{org_id} Get organization usage
• GET /api/v1/usage/org/{org_id}/logs List organization requests
• GET /api/v1/usage/org/{org_id}/budget Get organization budget burn

Account

The signed-in user's profile, data export and deletion.

• GET /api/v1/users/me Get your profile
• PUT /api/v1/users/me Update your profile
• DELETE /api/v1/users/me Delete your account
• GET /api/v1/users/me/export Export your data

Privacy

Data-subject erasure requests.

• POST /api/v1/gdpr/deletion-requests Request erasure
• GET /api/v1/gdpr/deletion-requests/me Get your erasure request

Organizations

Organizations, members and invitations.

• GET /api/v1/organizations List your organizations
• GET /api/v1/organizations/{org_id} Get an organization
• GET /api/v1/organizations/{org_id}/members List members
• POST /api/v1/organizations/{org_id}/invites Invite a member

Settings

Notification preferences and audit logs.

• GET /api/v1/settings/notifications Get notification preferences
• PUT /api/v1/settings/notifications Update notification preferences
• GET /api/v1/settings/audit-logs List audit log entries
• GET /api/v1/settings/audit-logs/export Export audit log entries

Integrations

Integration status, Slack notifications and the Jira configuration.

• GET /api/v1/integrations/status Get integration status
• GET /api/v1/integrations/config Get the Slack configuration summary
• POST /api/v1/integrations/slack/notify Send a Slack message
• POST /api/v1/integrations/slack/findings Send a findings alert to Slack
• GET /api/v1/integrations/jira Get the Jira configuration

Versioning

The API is versioned by its URL path (/v1). There is no version request header. Each documentation version is a dated snapshot of the /v1 surface, so you can see exactly what changed between snapshots. next previews changes that are not released or not stable yet.

Changelog

The changes between documentation versions are listed at https://dev.breachline.io/changelog/.

Accessing the API

Send a BreachLine API key (bl_live_…) as X-API-Key: <key> or Authorization: Bearer <key>. Create keys in the console under Settings, API & Developer. Most errors use the envelope { "error": { "status", "message", "code", "detail", "request_id" } }; the Anthropic-compatible endpoints use the Anthropic envelope, and a few edge responses (an oversized body, the per-user rate limits, an empty completion) do not use the envelope. See the Errors guide.

Rate limits

Chat completions and Responses are limited per API key per minute, hour and day, in fixed UTC windows. Embeddings, rerank and the Platform API are limited per user per minute, and Platform API responses carry X-RateLimit-* headers. A limited request gets 429. See the Rate limits guide.