Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Hiloop API key sent as an HTTP Bearer token.

Query Parameters

run_id
string

The run whose annotations to list. Exactly one of run_id or project_id is set.

schema_name
string

Restrict to one registered annotation-schema name. Naming the schema also applies its declared identity fields to the latest-wins key; without it the dedup uses the default key.

history
boolean

Return every stored version (newest first) instead of only the current one per supersession key. Nothing is ever mutated or hidden — history is always available.

project_id
string

The project whose run-less annotations to list. Exactly one of run_id or project_id is set.

Response

OK

annotations
object[]

One annotation per row, newest first. Each row carries the annotation's identity and anchor (event_id, run_id — absent on project-scoped rows — project_id, lineage_path, the schema name, ts_wall_ns, principal), its target (target_event_id, or the range bounds range_start_ns/range_end_ns plus range_start_event_id/range_end_event_id when the range was event-bounded), and the schema-validated payload as a raw JSON object string under payload_json — the exact bytes that were annotated (the write-side payload_json), so payload values of every JSON type, including 64-bit integers, read back unchanged. Row fields are encoded canonically: snake_case keys, 64-bit integers as decimal strings, absent fields omitted.

skipped
object[]

Stored rows this listing could not decode (a legacy or corrupt storage shape), one entry per skipped row. The readable annotations above still serve in full; a listing that omits rows says so here rather than failing outright or dropping them silently. Empty on a healthy store.

superseded_count
string

How many stored versions the default latest-wins view hid because a newer write shares their supersession key. Zero when nothing was superseded, and always zero with history (which returns every version). A non-zero count means acked writes are stored but not shown here — list with history to read them all.