API Reference
REST API
Authentication, versioning, and ZeroLeaks v1 HTTP endpoints.
REST API
All authenticated v1 requests use a ZeroLeaks API key:
Authorization: Bearer zl_live_...
Content-Type: application/jsonThe base URL is https://zeroleaks.ai/api/v1. The full machine-readable schema is served from https://zeroleaks.ai/openapi.json.
Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /health | Public service health |
GET | /capabilities | Public models, modes, surfaces, and limits |
POST | /scans | Create a prompt scan |
GET | /scans | List prompt scans |
GET | /scans/{id} | Read prompt scan state and report |
POST | /scans/{id}/cancel | Cancel a prompt scan |
GET | /reports | List prompt-scan reports |
GET | /reports/{id} | Get a report by ID |
GET | /reports/by-scan/{id} | Get a report by scan ID |
POST | /runtime-scans | Create an SDK relay scan |
GET | /runtime-scans/{id} | Read runtime scan state and report |
POST | /agent-configs | Create an HTTP endpoint configuration |
POST | /agent-scans | Scan a configured HTTP endpoint |
POST | /skill-scans | Scan a repository, URL, or ZIP archive |
Use the SDK when possible: it applies authentication, serializes request types, handles polling and cancellation, and runs the runtime relay protocol for local agents.