Viewer API reference#

Generated from the viewer's OpenAPI document by tools/gen_reference.py; do not edit by hand. A running viewer serves the same document at /openapi.json. Every state-changing route requires the X-BitExact-Action header, and so do the GET routes that produce evidence - export, evidence-pack (a run's, a case's, a selection's and a saved pack's), provenance-bundle and otel - because taking evidence out is an act that is itself recorded in each run's custody chain (see integrations.md). A route that takes a body says what it takes at /openapi.json.

• GET / - Index
• GET /api/access-log - Access Log View
• GET /api/agent-entries - List Agent Entries
• GET /api/case-vocabulary - Case Vocabulary
• GET /api/cases - Cases
• GET /api/cases/{case_id} - Case Detail
• POST /api/cases/{case_id} - Case Act
• GET /api/cases/{case_id}/evidence-pack - Case Evidence Pack
• GET /api/cost - Cost Ep
• GET /api/coverage - Coverage
• GET /api/coverage/expectations - Expectation List
• POST /api/coverage/expectations - Expectation Change
• GET /api/coverage/expectations/removals - Expectation Removals
• GET /api/coverage/sources - Coverage Sources
• GET /api/env - Env
• GET /api/events - Events View
• POST /api/events/retry - Events Retry
• POST /api/events/test - Events Test
• GET /api/evidence-pack - Selection Evidence Pack
• POST /api/fork-matrix - Start Fork Matrix
• GET /api/fork-matrix/{job_id} - Fork Matrix Job
• POST /api/forks - Create Fork
• GET /api/health - Health
• GET /api/jobs/{job_id} - Job Status
• GET /api/license - License Status
• GET /api/log - Transparency Log
• POST /api/logout - Sign Out
• GET /api/onboarding - Onboarding
• GET /api/packs - Packs
• POST /api/packs/{name} - Pack Act
• GET /api/packs/{name}/evidence-pack - Pack Evidence Pack
• GET /api/redactions - Redactions
• POST /api/regress - Start Regress
• GET /api/retention - Retention
• GET /api/retention/purge-preview - Purge Preview
• GET /api/roles - Roles View
• GET /api/runs - Runs
• GET /api/runs/{run_id} - Run Detail
• GET /api/runs/{run_id}/comparison - Fork Comparison
• GET /api/runs/{run_id}/cost - Run Cost Ep
• GET /api/runs/{run_id}/custody - Custody
• GET /api/runs/{run_id}/evidence-pack - Evidence Pack
• GET /api/runs/{run_id}/export - Export
• GET /api/runs/{run_id}/fork-estimate - Fork Estimate Ep
• GET /api/runs/{run_id}/fork-matrix - Fork Matrix Reports
• GET /api/runs/{run_id}/fork-matrix-compare - Fork Matrix Compare
• GET /api/runs/{run_id}/fork-matrix/cost - Fork Matrix Cost
• GET /api/runs/{run_id}/forks - Forks
• DELETE /api/runs/{run_id}/hold - Release Hold
• POST /api/runs/{run_id}/hold - Place Hold
• GET /api/runs/{run_id}/otel - Otel Spans
• GET /api/runs/{run_id}/provenance - Provenance
• GET /api/runs/{run_id}/provenance-bundle - Provenance Bundle
• POST /api/runs/{run_id}/redact - Redact
• GET /api/runs/{run_id}/redaction - Redaction Status
• POST /api/runs/{run_id}/redaction/approve - Redaction Approve
• POST /api/runs/{run_id}/redaction/reject - Redaction Reject
• POST /api/runs/{run_id}/redaction/request - Redaction Request
• GET /api/runs/{run_id}/reports - Reports
• GET /api/runs/{run_id}/reviews - Run Reviews
• GET /api/runs/{run_id}/steps/{step} - Step Payload
• GET /api/runs/{run_id}/verify - Verify
• GET /api/setup - Setup
• GET /api/suites - Suites
• POST /api/suites - Create Suite
• GET /api/suites/{name} - Suite Detail
• POST /api/suites/{name}/compare - Compare Suite Endpoint
• POST /api/suites/{name}/run - Run Suite Endpoint
• GET /api/summary - Summary
• GET /api/trust - Trust
• POST /api/verify-bundle - Verify Bundle Upload
• POST /api/verify-report - Verify Report Upload
• GET /api/whoami - Whoami
• GET /api/workflows - Workflows
• GET /api/workflows/{workflow}/governance - Workflow Governance
• GET /api/workflows/{workflow}/matrix - Workflow Matrix
• GET /api/workflows/{workflow}/versions - Workflow Versions Ep
• GET /healthz - Liveness
• GET /{name} - Asset