Render

List render jobs

List the account's render jobs, newest first. Filter by output type with type.

get/api/jobs

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/jobs
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

pageinteger

Page number (default 1)

limitinteger

Items per page (default 20, max 100)

type'video' | 'image'

Only return renders of this type

Response

Render jobs for the authenticated account

Example response

{
  "jobs": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "completed",
      "jobType": "video",
      "name": "spring-campaign-1",
      "creditsEstimated": 6,
      "creditsConsumed": 6,
      "videoDuration": 12.5,
      "videoResolution": "1920x1080",
      "outputUrl": "https://cdn.zvid.io/videos/123/video.mp4",
      "thumbnailUrl": "https://cdn.zvid.io/videos/123/thumbnail.jpg",
      "templateId": "tpl_rAequJHzUETcLAMfrezk"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "totalPages": 3,
    "hasNext": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.