Skip to content
VIDMOATDocs

List renders

GEThttps://api.vidmoat.com/v1/renders
Bearer tokenScope render.readFreeTry it in the playground

List your render jobs, newest first. Filter by projectId or status, and page with cursor.

Query parameters#

  • limitintegerdefault 20
    Page size, up to 100.
  • cursorstring
    The nextCursor of the previous page.
  • projectIdstring
    Only this project's renders.
  • statusstring
    Only renders in this status (case does not matter).

Response#

Returns 200.

Response fields#

  • dataarray
    Render jobs.
    Show 11 child fields
    • idstring
      Render job id.
    • projectIdstring
      The project rendered.
    • statusenum
      Where the job is.
      One of PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
    • progressinteger
      0 to 100.
    • formatstring
      mp4, webm or gif.
    • resolutionstring
      full or half.
    • qualitystring
      draft, standard or high.
    • urlstring or null
      The download URL once COMPLETED.
    • errorstring or null
      Why it failed, when FAILED.
    • createdAtstring
      ISO 8601 time.
    • updatedAtstring
      ISO 8601 time.
  • hasMoreboolean
    Another page exists.
  • nextCursorstring or null
    Pass as cursor.