v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

media renditions

Create a media rendition

post/v2/sites/{site_id}/media/{media_id}/media_renditions/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

media_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the media

Request body

Example request

{
  "relationships": {
    "media_rendition_template": {
      "id": "Ny05CEfj"
    }
  }
}

Response

Resource successfully created

schemastring

idstring

Unique identifier for a resource

createdstring

Date and time at which the resource was created

last_modifiedstring

Date and time at which the resource was most recently modified

typestring

Name of the type of resource.

metadataobject

heightinteger

widthinteger

formatstring

Extension format of the rendition

delivery_urlstring

URL to access the media rendition This URL is only returned when the media rendition status is ready.

error_messagestring

A human-readable error message for describing failures

status'failed' | 'processing' | 'ready'

filesizeinteger

Size of the media rendition, in bytes

Example response

{
  "schema": "https://schema.jwplayer.com/types/thumbnail.json",
  "id": "Ny05CEfj",
  "created": "2019-09-25T15:29:11.042095+00:00",
  "last_modified": "2019-09-25T15:29:11.042095+00:00",
  "relationships": {
    "media_rendition_template": {
      "id": "Ny05CEfj"
    }
  },
  "height": 480,
  "width": 720,
  "status": "ready"
}