Graph API Version

Video Thumbnails

Represents a collection of VideoThumbnails on a Video

Reading

Get a list of VideoThumbnails on a Video.

Requirements

TypeRequirement

Access Tokens

App or Page

Permissions

pages_read_engagement, pages_show_list

Examples

curl -X GET "https://graph.facebook.com/v19.0/video-id/thumbnails?access_token=page_access_token"

On success your app receives a list of VideoThumbnail objects for the video.

{
"id": "video-id-1",
"height": 1280,
"scale": 1,
"uri": "url-for-video-1",
"width": 720,
"is_preferred": false
},
{
"id": "video-id-2",
"height": 1280,
"scale": 1,
"uri": "url-for-video-2",
"width": 720,
"is_preferred": false
},
...

Parameters

This endpoint doesn't have any parameters.

Fields

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {} }

data

A list of VideoThumbnail nodes.

paging

For more details about pagination, see the Graph API guide.

Error Codes

ErrorDescription
368The action attempted has been deemed abusive or is otherwise disallowed
100Invalid parameter
200Permissions error
190Invalid OAuth 2.0 Access Token
104Incorrect signature

Creating

You can make a POST request to thumbnails edge from the following paths:
When posting to this edge, a VideoThumbnail will be created.

Limitations

  • Maximum thumbnail file size 10MB.
  • Thumbnails can only be created on Videos that have been associated with a Page.
  • We recommend that you use thumbnails with the same aspect ratio as the video.

Requirements

TypeRequirement

Access Tokens

App or Page

Permissions

pages_read_user_content, pages_manage_engagement, pages_show_list

Examples

curl -X POST "https://graph.facebook.com/v19.0/video-id/thumbnails
   ?access_token=page_access_token
   &is_preferred=true
   &source=@ThumbnailSample1.jpg"

On success your app receives a list of VideoThumbnail objects for the video.

{
  "success": true
}

Parameters

ParameterDescription
is_preferred
boolean
Default value: false

Set to true if this thumbnail is the preferred thumbnail to be shown for this video

source
image

The source for the thumbnail, an image file

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
190Invalid OAuth 2.0 Access Token

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.