Skip to content
VIDMOATDocs

Create a project

POSThttps://api.vidmoat.com/v1/projects
Bearer tokenScope projects.writeproject quotaTry it in the playground

Create an empty 16:9, 1920x1080, 30 fps project, optionally applying a first batch of commands. Counts against the plan's project limit.

Body#

  • namestringdefault Untitled Project
    Up to 80 characters.
  • commandsarray of objects
    Optional commands to apply straight after creation, with the same rules as Apply commands. If they fail, the project is still created.

Response#

Returns 201.

Response fields#

  • projectobject
    The new project, summary view.
    Show 8 child fields
    • idstring
      Project id.
    • namestring
      Project name.
    • createdAtstring
      ISO 8601 time.
    • updatedAtstring
      ISO 8601 time.
    • durationSecnumber
      End of the last clip, in seconds.
    • clipCountinteger
      Number of clips on the timeline.
    • settingsobject
      Output settings.
      Show 5 child fields
      • aspectRatiostring
        For example 16:9.
      • widthinteger
        Pixels.
      • heightinteger
        Pixels.
      • fpsnumber
        Frames per second.
      • backgroundstring
        CSS colour.
    • workspaceobject or null
      The workspace it is filed in: { id, name }, or null.
  • resultsarray
    Only when you sent commands. See Apply commands.

Errors#

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

StatusCodeWhen
402quota_exceededThe plan's project limit is reached.