Skip to main content
GET
Download a rendered SBOM document (original bytes)

Authorizations

Authorization
string
header
required

An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.

Path Parameters

snapshotId
string<uuid>
required

Query Parameters

format
enum<string>

Rendered SBOM format. cyclonedx (1.7) and spdx (2.3 Lite) can be produced by either generate or render-new-format. attribution is the OSPO attribution/notice document — it is render-only: POST .../scans/{scanId}:generate always rejects it (unsupported_format); only POST .../snapshots/{snapshotId}:render can produce it. It is rendered once from the stored inventory plus a live attribution fetch, then frozen like any other artifact — its SnapshotArtifact.attribution_fetched_at records when that fetch happened. export-control is a self-contained HTML evidence report frozen only when an entitled crypto snapshot is generated; it is download-only. cra-sbom-annex is a generation-only CycloneDX 1.7 variant containing cryptographic assets as components. It accompanies a product SBOM; it is not a CRA conformity assessment. report-html, report-csv, report-xlsx and report-pdf are the human-readable report of the snapshot: a summary, the components and licenses, the vulnerabilities, the crypto inventory and the AI models the snapshot holds, and the review state frozen with it. They are render-only like attribution, but need no upstream fetch: both are built from the stored inventory alone. report-html is one self-contained, print-friendly page; report-csv is a .zip of one UTF-8 CSV per section. A section the caller may not see is in none of them.

Available options:
cyclonedx,
spdx,
attribution,
export-control,
cra-sbom-annex,
report-html,
report-csv,
report-xlsx,
report-pdf

Response

The rendered document bytes.

The response is of type object.