ZeroLeaksDocs
API Reference

ZeroLeaks API reference

Reference for the ZeroLeaks SDK client, scan namespaces, runtime targets, reports, types, and errors.

The @zeroleaks/sdk client exposes one namespace for each ZeroLeaks scan path.

NamespacePurpose
scansHistorical system-prompt scans (retired: get, list, wait, and cancel only; create and run throw PROMPT_SCANS_RETIRED)
runtimeScansAgent scans that execute through local application code
endpointConfigsDeployed HTTP agent configuration
endpointScansAgent scans against deployed HTTP agents
skillScansRepository, URL, and ZIP skill scans
reportsPrompt-scan report retrieval
healthUnauthenticated service health
capabilitiesModels, modes, surfaces, and API limits

agentConfigs and agentScans remain compatibility aliases for endpointConfigs and endpointScans.

import { ZeroLeaks } from "@zeroleaks/sdk";

const zeroleaks = new ZeroLeaks();

The SDK uses the versioned /api/v1 API. A machine-readable OpenAPI specification is also available at /openapi.json on the ZeroLeaks domain.