project.create · Umwelt docs

Reference/Commands/project.create

project.createcommandsince 0.1

Creates a project inside the file. Projects are isolated from each other.

Command lineTypeScript.NET

Request

umwelt call story.umw project.create '{
  "id": "ball",
  "name": "The Ball",
  "timescale": "scene"
}'

Request

const result = await client.projectCreate({ id: 'ball', name: 'The Ball', timescale: 'scene' });

Request

var result = engine.ProjectCreate(new CreateProjectInput
{
    Id = "ball",
    Name = "The Ball",
    Timescale = "scene",
});

Response

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

Payload

Field	Type	Description
`id`	string	Its id. Generated when absent.
`name`required	string	Its name.
`timescale`required	string	What a tick means: `day`, `turn`, `scene`. Only a label.
`description`	string	What it is.
`vocabularyMode`	"strict" \| "open"default "strict"	`strict` refuses claims with undefined predicates. `open` accepts them with an `UNKNOWN_PREDICATE` warning.

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

Nothing crosses projects. No read in one project sees anything of another.

Errors

VALIDATION_FAILEDThe payload is malformed.

CONFLICTA project with that id exists.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also