Graph API Version

Video Thumbnail

Represents an video's thumbnail on Facebook.



Reading

A Video Thumbnail

Example

Graph API Explorer
GET v3.3/...?fields={fieldname_of_type_VideoThumbnail} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '...?fields={fieldname_of_type_VideoThumbnail}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "...?fields={fieldname_of_type_VideoThumbnail}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_VideoThumbnail}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"...?fields={fieldname_of_type_VideoThumbnail}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The ID of the thumbnail

height
unsigned int32

The height of the thumbnail

is_preferred
bool

Whether this is the preferred thumbnail for the video

name
string

The name of the thumbnail

scale
float

The scale of the thumbnail

uri
string

The URI of the thumbnail

width
unsigned int32

The width of the thumbnail

Creating

Limitations

  • The file size limit for video thumbnails is 10MB
  • We recommend you use thumbnails with the same aspect ratio as the video.

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

Parameters

ParameterDescription
is_preferred
boolean
Default value: false

Whether to set this thumbnail as the preferred thumbnail of the video

source
image

Thumbnail image file

Required

Return Type

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

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.