Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
thumbnails

Create a thumbnail

Create a thumbnail

post/v2/sites/{site_id}/thumbnails/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Request body

Example request

{
  "relationships": {
    "media": [
      {
        "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.

delivery_urlstring

Link to retrieve thumbnail

The value of this parameter will be null until it has been successfully uploaded and status is set to ready.

file_type'jpeg' | 'mp4'

File extension used for this thumbnail

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

Readiness state of this thumbnail

thumbnail_type'static' | 'video'
source_type'custom_upload' | 'default' | 'generic_audio' | 'generic_video' | 'thumbstrip_image'

Source of the thumbnail upload

Possible Values:

  • custom_upload: User-provided thumbnail
  • default: Default thumbnail automatically pulled from 10 seconds into the video
  • generic_audio: Default thumbnail created for externally hosted media with media_type set to audio
  • generic_video: Default thumbnail created for externally hosted media with media_type set to video
  • thumbstrip_image: Thumbnail selected from the thumbstrip images via video_position or thumbstrip_index
metadataThumbnailResourceMetadata

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": [
      {
        "id": {
          "id": "Ny05CEfj"
        }
      }
    ]
  },
  "delivery_url": "https://cdn.jwplayer.com/v2/media/asdf1234/thumbnails/qwer4567"
}