Back to Help

api

Render Endpoints

Create and track video render jobs.

Audience: developer

Endpoints

  • POST /v1/renders
  • GET /v1/renders
  • GET /v1/renders/:id
  • DELETE /v1/renders/:id

Status Lifecycle

Typical statuses:

  • queued
  • processing
  • rendering
  • completed
  • failed
  • canceled

Create Render Example

curl -s https://api.slidevids.com/v1/renders \
  -X POST \
  -H "x-api-key: $SLIDEVIDS_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "timeline_id": "tmpl_xxx",
    "output": {
      "resolution": "1080p",
      "codec": "h264",
      "format": "landscape"
    },
    "webhook_url": "https://example.com/hooks/slidevids"
  }'

Poll Render Example

curl -s https://api.slidevids.com/v1/renders/render_xxx \
  -H "x-api-key: $SLIDEVIDS_API_KEY"

Cancel Render

curl -X DELETE https://api.slidevids.com/v1/renders/render_xxx \
  -H "x-api-key: $SLIDEVIDS_API_KEY"

Related: /help/api/webhooks