Skip to main content

API reference

Every public endpoint, grouped by API, with links to the generated reference for each dated version.

On this page

Reference by version

The reference is generated from a curated OpenAPI document and published as static pages, one per section, with every field, response and a cURL example. It lists exactly the endpoints on this page. It has no Try it feature; call the API from your own environment.

VersionStatusReferenceOpenAPI
2026-11-11CurrentOpen /api/openapi-2026-11-11.json
nextPreviewOpen /api/openapi-next.json

See Versioning for what each status means.

APIs

Base URL and authentication

All endpoints are served from https://api.breachline.io over HTTPS. Authenticate with X-API-Key: <key> or Authorization: Bearer <key>; see Authentication and API keys.

Endpoint index

Method Path API
POST /api/v1/llm/v1/chat/completions Chat completions
GET /api/v1/llm/v1/models Models
POST /api/v1/llm/v1/responses Responses
GET DELETE /api/v1/llm/v1/responses/{response_id} Responses
POST /api/v1/llm/v1/embeddings Embeddings
POST /api/v1/llm/v1/rerank Rerank
POST GET /api/v1/llm/v1/batches Batches
GET /api/v1/llm/v1/batches/{batch_id} Batches
POST /api/v1/llm/v1/batches/{batch_id}/cancel Batches
GET /api/v1/llm/v1/batches/{batch_id}/results Batches
POST /api/v1/llm/v1/files Batches
GET /api/v1/llm/v1/files/{file_id}/content Batches
POST /api/v1/llm/v1/messages Anthropic-compatible (beta)
POST /api/v1/llm/v1/messages/count_tokens Anthropic-compatible (beta)
POST /api/v1/keys/create API keys
GET /api/v1/keys/list API keys
DELETE /api/v1/keys/{key_id} API keys
POST /api/v1/keys/refresh/{key_id} API keys
GET /api/v1/usage/me, /me/logs, /me/budget Usage
GET PUT DELETE /api/v1/usage/me/budget/cap Usage
GET /api/v1/usage/org/{org_id}, /logs, /budget Usage
GET PUT DELETE /api/v1/users/me Account
GET /api/v1/users/me/export Account
POST /api/v1/gdpr/deletion-requests Account
GET /api/v1/gdpr/deletion-requests/me Account
GET /api/v1/organizations, /{org_id}, /{org_id}/members Organizations
POST /api/v1/organizations/{org_id}/invites Organizations
GET PUT /api/v1/settings/notifications Settings
GET /api/v1/settings/audit-logs, /export Settings
GET /api/v1/integrations/status, /config, /jira Integrations
POST /api/v1/integrations/slack/notify, /slack/findings Integrations

Search documentation

Type to search guides, the API reference, the CLI and the console guide.

    Enter open↑ ↓ moveEsc close