Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
Method: projects.locations.videoThumbnails.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates an ID that can be used to render an image containing an animation of multiple images from a collection.
This is used in conjunction with GetVideoThumbnailPixels. A call to videoThumbnails.create provides an expression and some output options. The result of videoThumbnails.create is an ID that represents an image that is the result of evaluating that expression and applying those options. Subsequently, calls to GetVideoThumbnailPixels can be made to get an image showing all of the elements of an ImageCollection, animated from first to last. The ID will be valid for a moderate period (a few hours).
The request is limited to 512*512*100 pixels in total, across all Images in the ImageCollection. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).
HTTP request
POST https://earthengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/videoThumbnails
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent of the location where the video thumbnail will be created (e.g., "projects/*").
Authorization requires the following IAM permission on the specified resource parent:
earthengine.videothumbnails.create
|
Query parameters
| Parameters |
workloadTag |
string
User supplied tag to track this computation.
|
Request body
The request body contains an instance of VideoThumbnail.
Response body
If successful, the response body contains a newly created instance of VideoThumbnail.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/earthengine
https://www.googleapis.com/auth/earthengine.readonly
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eGenerates an ID, usable with \u003ccode\u003eGetVideoThumbnailPixels\u003c/code\u003e, to render an animation of images from an ImageCollection.\u003c/p\u003e\n"],["\u003cp\u003eThe created ID represents an image formed by evaluating an expression and applying specified options, animating the ImageCollection's elements.\u003c/p\u003e\n"],["\u003cp\u003eThe total pixel limit for the request is 512*512*100, exceeding which results in a 400 error code.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific IAM permission (\u003ccode\u003eearthengine.videothumbnails.create\u003c/code\u003e) on the parent resource for authorization.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes a POST request to a specified endpoint with path and query parameters to create the video thumbnail.\u003c/p\u003e\n"]]],["`videoThumbnails.create` generates an ID for an animated image from an ImageCollection, using a provided expression and output options. `GetVideoThumbnailPixels` then retrieves the animated image. The ID remains valid for a few hours. The request has a size limit of 512\\*512\\*100 pixels, exceeding this results in a 400 error. A tag is used to track the computation. Authentication requires specific OAuth scopes or IAM permissions on the parent resource.\n"],null,["# Method: projects.locations.videoThumbnails.create\n\nCreates an ID that can be used to render an image containing an animation of multiple images from a collection.\n\nThis is used in conjunction with `GetVideoThumbnailPixels`. A call to `videoThumbnails.create` provides an expression and some output options. The result of `videoThumbnails.create` is an ID that represents an image that is the result of evaluating that expression and applying those options. Subsequently, calls to `GetVideoThumbnailPixels` can be made to get an image showing all of the elements of an ImageCollection, animated from first to last. The ID will be valid for a moderate period (a few hours).\n\nThe request is limited to 512\\*512\\*100 pixels in total, across all Images in the ImageCollection. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/videoThumbnails`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent of the location where the video thumbnail will be created (e.g., \"projects/\\*\"). Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `earthengine.videothumbnails.create` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------|\n| `workloadTag` | `string` User supplied tag to track this computation. |\n\n### Request body\n\nThe request body contains an instance of [VideoThumbnail](/earth-engine/reference/rest/v1alpha/projects.locations.videoThumbnails#VideoThumbnail).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [VideoThumbnail](/earth-engine/reference/rest/v1alpha/projects.locations.videoThumbnails#VideoThumbnail).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/earthengine.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]