Skip to content

Getting started

Projects

Create, list, open and trash projects, with the same result from the CLI, MCP and the HTTP API.

Last updated:

You will learn#

  • how to create a project with a format that fits the platform;
  • how to list and read projects;
  • what the revision number means.

The idea#

A project is one JSON document: tracks, items, the assets it uses and its settings. Every change is a batch of operations that raises its revision by one, so a project always has a clean history you can undo.

Quick start#

Terminal
vukem-video project:create --name "Launch teaser" --preset 9:16 --json
vukem-video project:list --json
vukem-video project:show prj_7k2m9x4q1b

The presets are 9:16 (the default, for short vertical video), 1:1, 16:9 and 4:5. The frame rate defaults to 30 and can be 30000/1001. A new project is at revision 0.

Common mistakes#

  • Using a project id from another workspace. A project id looks like prj_7k2m9x4q1b; an unknown one is E_NOT_FOUND.
  • Editing a trashed project. Restore it first with project:restore; the error is E_INVALID_STATE.

Next steps#