RegisteredFile

What a Register answers: the version, its family, and whether an identical earlier registration had already made it.

Type object

Shape

Field	Type	Description
versionrequired	ArtifactVersion	One immutable artifact version. Identity is `id`; content is `blob`, an address in the workspace's content-addressed store. The two are separate on purpose: the same bytes registered twice are two versions with two histories, and a reference to a version keeps meaning the same thing after the family moves on. `derived_from` names the version this one was made from, which is how a provenance walk crosses generations.
familyrequired	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).
retriedrequired	boolean

Example

{
  "version": {
    "id": "00000000-0000-4000-8000-000000000000",
    "family": "00000000-0000-4000-8000-000000000000",
    "ordinal": 0,
    "blob": "string",
    "size_bytes": 0,
    "mime": "string",
    "filename": "string",
    "produced_by": {
      "run": "00000000-0000-4000-8000-000000000000",
      "generation": 0
    },
    "registration_id": "00000000-0000-4000-8000-000000000000",
    "derived_from": "00000000-0000-4000-8000-000000000000",
    "created_at_ms": 0
  },
  "family": {
    "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
  },
  "retried": false
}

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

POST/v1/artifacts/runs/{run}/register
Register a file the run left in its results folder (D19)

Generated from contract version 1. Last updated November 12, 2026.