Get a render

GEThttps://api.vidmoat.com/v1/renders/{id}

Bearer tokenScope render.readFreeTry it in the playground

Poll a job: PENDING, then PROCESSING, then COMPLETED or FAILED, with progress 0 to 100 and the download URL on completion.

Path parameters#

idstringrequired
The render job id.

Response#

Returns 200.

Response fields#

renderobject
The job.
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.

Errors#

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

Status	Code	When
404	`not_found`	No such job, or not yours.

curl

curl https://api.vidmoat.com/v1/renders/$JOB_ID \
  -H "Authorization: Bearer $VIDMOAT_KEY"

Response 200

{
  "render": {
    "id": "clx9abc123", "projectId": "cm1abc", "status": "PROCESSING", "progress": 42,
    "format": "mp4", "resolution": "full", "quality": "standard",
    "url": null, "error": null,
    "createdAt": "2026-10-03T12:00:00.000Z", "updatedAt": "2026-10-03T12:00:31.000Z"
  }
}