Update a project

PATCHhttps://api.vidmoat.com/v1/projects/{id}

Bearer tokenScope projects.writeFreeTry it in the playground

Rename, or change output settings: aspect ratio, frame rate, background, width and height. Timeline edits go through commands.

Path parameters#

idstringrequired
The project id.

Body#

namestring
Up to 80 characters. Must not be empty.
aspectRatioenum
Also sets width and height (for example 9:16 is 1080x1920).
One of 16:9, 9:16, 1:1, 4:5, 4:3, 21:9
fpsnumber
1 to 120.
backgroundstring
CSS colour.
widthinteger
Pixels. Applied after aspectRatio.
heightinteger
Pixels. Applied after aspectRatio.

Response#

Returns 200.

Response fields#

projectobject
Summary view, after the change.
resultsarray
One entry per command: { op, ok, error?, data? }. A failed command is reported here, not as an HTTP error.
verificationobject
What happened: accepted (count), failed ([{ op, error }]), blocked, layout warnings, and outcome (executed, needs-repair or blocked).

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
404	`not_found`	No such project, or it is not yours. The two are indistinguishable on purpose.
400	`invalid_request`	No supported field was sent, or `name` is empty.
409	`invalid_request`	The project changed while the batch ran (`conflictCode: "stale_rev"`, with `rev`) or is locked by an expert handoff (`help_handoff_locked`). Re-read the project and retry.

curl

curl -X PATCH https://api.vidmoat.com/v1/projects/$ID \
  -H "Authorization: Bearer $VIDMOAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Renamed"}'

Response 200

{
  "project": {
    "id": "cm1abc",
    "name": "Launch teaser",
    "createdAt": "2026-09-30T10:00:00.000Z",
    "updatedAt": "2026-10-02T09:00:00.000Z",
    "durationSec": 12.5,
    "clipCount": 4,
    "settings": { "aspectRatio": "9:16", "width": 1080, "height": 1920, "fps": 30, "background": "#000000" },
    "workspace": null
  },
  "results": [{ "op": "setProjectSettings", "ok": true }]
}