Skip to main content
API reference sections

Schema

RegisterVersionRequest

POST /v1/artifacts/families/{family}/versions. Metadata only: the blob is an address in the family's workspace, already uploaded through the Store's blob route, and the gateway verifies it is there before the version exists. The size is the Store's word, not the caller's.

Type object

Shape

FieldTypeDescription
registration_idrequiredRegistrationId
blobrequiredBlobHash

<algorithm>:<digest> - b3:<64 hex>.

The algorithm is in the value because a hash that does not say what it is cannot be migrated: adopting a second one has to be additive, or every document already written is orphaned.

mimerequiredMediaType

A type/subtype media type, ASCII and lowercased, as the blob store records it. Not content: it prints in full.

filenameFilename or null
produced_byProducedBy or null
derived_fromArtifactVersionId or null
Example
{
  "registration_id": "00000000-0000-4000-8000-000000000000",
  "blob": "string",
  "mime": "string",
  "filename": "string",
  "produced_by": {
    "run": "00000000-0000-4000-8000-000000000000",
    "generation": 0
  },
  "derived_from": "00000000-0000-4000-8000-000000000000"
}

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.