evidence.register · Umwelt docs

Reference/Commands/evidence.register

evidence.registercommandsince 0.1

Registers a source, such as a document or a recording, that events and Holdings can cite.

Command lineTypeScript.NET

Request

umwelt call story.umw evidence.register '{
  "projectId": "ball",
  "id": "guest-list",
  "title": "The guest list",
  "type": "document",
  "createdAt": "2026-11-07T20:00:00Z",
  "description": "Everyone announced at the door."
}'

Request

const result = await client.evidenceRegister({
  projectId: 'ball',
  id: 'guest-list',
  title: 'The guest list',
  type: 'document',
  createdAt: '2026-11-07T20:00:00Z',
  description: 'Everyone announced at the door.',
});

Request

var result = engine.EvidenceRegister(new EvidenceSource
{
    ProjectId = "ball",
    Id = "guest-list",
    Title = "The guest list",
    Type = "document",
    CreatedAt = "2026-11-07T20:00:00Z",
    Description = "Everyone announced at the door.",
});

Response

{
  "id": "guest-list",
  "projectId": "ball",
  "title": "The guest list",
  "createdAt": "2026-11-07T20:00:00Z",
  "description": "Everyone announced at the door.",
  "type": "document"
}

Payload

Field	Type	Description
`projectId`required	string	The project to write to.
`id`required	string	Its id.
`title`required	string	Its title.
`type`required	string	What it is: a document, a recording, a letter.
`createdAt`required	string	When the source was made.
`description`	string	What it holds.
`contentHash`	string	A hash of its content.
`locator`	string	Where to find it.
`metadata`	object	Anything else, as JSON.

Result

Field	Type	Description
`id`always	string	The source’s id, cited by events and by `evidence` acquisitions.
`projectId`always	string	The project it belongs to.
`title`always	string	Its title.
`type`always	string	What it is: a document, a recording, a letter.
`createdAt`always	string	When the source was made, as you give it.
`description`	string	What it holds.
`locator`	string	Where to find it: a path, a URL, a shelf mark.
`contentHash`	string	A hash of its content, to notice when it changes.
`metadata`	object	Anything else, as JSON.

Rules

Evidence grants nothing by itself. A Holding acquired from it says so with { "kind": "evidence", "evidenceId": … }; the source alone makes nobody know anything.

Errors

VALIDATION_FAILEDThe payload is malformed.

CONFLICTA source with that id exists.

NOT_FOUNDThe project does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also