Projects

Update a project

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

Send at least one field. A value the editor rejects (an unknown aspect ratio, for example) comes back as a failed entry in results with a 200, not as an HTTP error.

patch/projects/{id}

Request

  • Base URL: https://api.vidmoat.com/v1
  • URL: https://api.vidmoat.com/v1/projects/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The project id.

Request body

namestring

Up to 80 characters. Must not be empty.

aspectRatio'16:9' | '9:16' | '1:1' | '4:5' | '4:3' | '21:9'

Also sets width and height (for example 9:16 is 1080x1920).

fpsnumber

1 to 120.

backgroundstring

CSS colour.

widthinteger

Pixels. Applied after aspectRatio.

heightinteger

Pixels. Applied after aspectRatio.

Response

Update a project

projectobject

Summary view, after the change.

verificationobject

What happened: accepted (count), failed ([{ op, error }]), blocked, layout warnings, and outcome (executed, needs-repair or blocked).

Changes

No recorded changes to this operation across all 1 revision of this API.