Methods
Every method the API answers, what it takes, what it gives back.
Start
Projects
project.createCreates a project folder underlocation, namedname, and opens itproject.openOpens a project folderproject.closeCloses an open project, saving first when askedproject.listThe projects this machine opened most recently, newest firstproject.getThe state of an open projectproject.documentThe document exactly as a save would write itproject.saveWrites the document to the project folderproject.setVideoSets the active timeline's frame and rate, as an undoable edit
Editing
Media
Effects
Templates
Export
Preview
How to read this page
- Examples are bare requests, the shape
concat-cli apitakes on stdin. On a socket or over gRPC the same fields go inparamsinside the envelope. See JSON-RPC. - Replies are shown as the
resultpayload alone. - optional parameters may be left out; the default is stated.
pathis always the project folder, and it must be open first, or the reply isnotOpen.