Skip to main content
API reference sections

Schema

ArtifactFamily

One artifact family. Workspace-scoped (D11), titled by a person or by the run that made it, and retired rather than deleted: retired_at_ms is a mark a reader can see and compare, and every version under a retired family stays readable (PRINCIPLES, retire state).

Type object

Shape

FieldTypeDescription
idrequiredArtifactFamilyId
workspacerequiredWorkspaceId
titlerequiredArtifactTitle

The title a result is named by on a device that cannot open its bytes (D27). A title is content: it is redacted like the objective.

created_by_runRunId or null

The run whose registration created the family, when an agent did (D6); None when a person created it by hand.

created_at_msrequiredinteger (int64)
retired_at_msinteger (int64) or null

Set once, by [crate::ArtifactRepository::retire_family]. A retired family accepts no new version and is left out of the ordinary listing.

Example
{
  "id": "00000000-0000-4000-8000-000000000000",
  "workspace": "00000000-0000-4000-8000-000000000000",
  "title": "string",
  "created_by_run": "00000000-0000-4000-8000-000000000000",
  "created_at_ms": 0,
  "retired_at_ms": 0
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.