evidence.get · Umwelt docs

Reference/Queries/evidence.get

evidence.getquerysince 0.1

One evidence source by its id.

Command lineTypeScript.NET

Request

umwelt call story.umw evidence.get '{
  "projectId": "ball",
  "evidenceId": "guest-list"
}'

Request

const result = await client.evidenceGet({ projectId: 'ball', evidenceId: 'guest-list' });

Request

var result = engine.EvidenceGet(new EvidenceId { ProjectId = "ball", EvidenceIdValue = "guest-list" });

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 read.
`evidenceId`required	string	The source.

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.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project or the source does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Errors

See also