Skip to content
VIDMOATDocs

Get a project

GEThttps://api.vidmoat.com/v1/projects/{id}
Bearer tokenScope projects.readFreeTry it in the playground

One project. The default clips view lists tracks and clips; ?view=document returns the full edit document.

Path parameters#

  • idstringrequired
    The project id.

Query parameters#

  • viewenumdefault clips
    How much to return.
    One of summary, clips, document

Response#

Returns 200.

Response fields#

  • projectobject
    The project in the chosen view.
    Show 11 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.
    • tracksarray
      Only in the clips and document views. The timeline tracks.
    • clipsarray
      Only in the clips view: a summary per clip (id, type, name, start, duration, trackIndex, and src, text, effects, speed, keyframedProps when set).
    • documentobject
      Only in the document view: the full edit document, verbatim.

Errors#

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

StatusCodeWhen
404not_foundNo such project, or it is not yours. The two are indistinguishable on purpose.