Skip to main content
POST
Render an existing snapshot into another format

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

Body

application/json

Which format to render from an existing snapshot's stored inventory.

format
enum<string>
required
Available options:
cyclonedx,
spdx,
attribution,
report-html,
report-csv,
report-xlsx,
report-pdf

Response

The snapshot with the newly-attached (or already-present) artifact.

id
string<uuid>
required
scan_id
string<uuid>
required
project_id
string<uuid>
required
generated_at
string<date-time>
required
generated_by
object
required

The actor that generated the snapshot (audit provenance).

review_coverage
number<double>
required

Share of reviewable finding occurrences with a current decision at generation time, 0..1 (soft gate — never blocks). Multiple files of one component are separate occurrences.

component_count
integer
required
include_vulnerabilities
boolean
required
include_crypto
boolean
required

Same as includes containing crypto.

includes
enum<string>[]
required

The sections this snapshot was generated with. A section that came out empty is still listed.

A section a snapshot holds. oss is the open-source components (an SBOM), crypto the cryptographic assets (a CBOM), ai the identified AI models (an AIBOM).

Available options:
oss,
crypto,
ai
model_count
integer
required

How many identified AI models the snapshot froze.

inventory_schema_version
string
required
artifacts
object[]
required
stale
boolean

True when the current effective decisions differ from the set captured for generation, including withdrawn decisions after reopening. Also true when currentness cannot be verified (legacy missing capture or unreadable review state). Only set on the newest snapshot in a project list; a read-time comparison, not stored state.