project.get · Umwelt docs

Reference/Queries/project.get

project.getquerysince 0.1

One project, with its current version.

Command lineTypeScript.NET

Request

umwelt call story.umw project.get '{
  "projectId": "ball"
}'

Request

const result = await client.projectGet({ projectId: 'ball' });

Request

var result = engine.ProjectGet(new ProjectId { ProjectIdValue = "ball" });

Response

{
  "id": "ball",
  "version": 17,
  "name": "The Ball",
  "createdAt": "2026-11-11T18:21:58.5898875Z",
  "timescale": "scene",
  "vocabularyMode": "strict"
}

Payload

Field	Type	Description
`projectId`required	string	The project to read.

Result

Field	Type	Description
`id`always	string	The project’s id, given or generated.
`name`always	string	Its name.
`description`	string	Its description.
`timescale`always	string	What a tick means: a day, a turn, a scene.
`vocabularyMode`always	"strict" \| "open"	`strict` refuses undefined predicates; `open` accepts them with a warning.
`createdAt`always	string	When it was created (UTC).
`version`always	integer	The head version of its main timeline. 0 before the first commit.

Rules

The version is main’s. version is the head of the main timeline. Commits to drafts take numbers from the same counter, so main’s versions can skip.

Errors

VALIDATION_FAILEDThe payload is malformed.

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