Skip to main content
Generates a compliance report for a single session. The report is produced on demand by walking the session’s audit log — it is not cached, and each call regenerates it from source. Two formats are available: a structured JSON document conforming to Masker Audit Schema v1 (for programmatic processing or ingestion into your compliance tooling), and an auditor-ready PDF. Both formats share the same merkle_root_hex, which ties the report to the session’s immutable audit chain.

Endpoint

Requires masker_session authentication.

Path parameters

string
required
The session’s ID in sess_* ULID format, e.g. sess_01HYZ....

Query parameters

string
default:"json"
Output format. json returns Masker Audit Schema v1 JSON. pdf returns a binary PDF suitable for auditors and regulators.

Response

JSON format

Returns 200 OK with Content-Type: application/json.
object
required
Masker Audit Schema v1 report object.

PDF format

Returns 200 OK with Content-Type: application/pdf and a Content-Disposition: attachment header. The response body is a binary PDF. Download it directly to a file.

Examples

JSON response

Notes

  • Reports are generated on demand. Each request walks the full audit log for the session; there is no caching.
  • The merkle_root_hex in the JSON report matches the value in the PDF. You can use it to independently verify that the two representations are consistent.
  • Per-agent and account-wide report endpoints (/api/v1/agents/{id}/report and /api/v1/reports) are on the May 30 production roadmap.

Errors