Announcement: All noncommercial projects registered to use Earth Engine before April 15, 2025 must verify noncommercial eligibility to maintain Earth Engine access.
The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is projects/{project-id}.
Authorization requires the following IAM permission on the specified resource project:
earthengine.exports.create
Request body
The request body contains data with the following structure:
Options for where and in what form to export the video.
requestId
string
A unique string used to detect duplicated requests. If more than one request is made by the same user with the same non-empty requestId, only one of those requests may successfully start a long-running operation. requestId may contain the characters a..z, A..Z, 0-9, or '-'. requestId may be at most 60 characters long.
workloadTag
string
User supplied label to track this computation.
priority
integer
Optional. The priority of the export task within the project. Higher priority tasks are scheduled sooner. Must be an integer between 0 and 9999. Defaults to 100 if not set.
Response body
If successful, the response body contains an instance of Operation.
Options for exporting videos as files outside Earth Engine.
JSON representation
{"fileFormat": enum (VideoFileFormat),// Union field destination can be only one of the following:"driveDestination": {object (DriveDestination)},"cloudStorageDestination": {object (CloudStorageDestination)}// End of list of possible types for union field destination.}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eInitiates a batch process to compute and export a video based on an Earth Engine image collection.\u003c/p\u003e\n"],["\u003cp\u003eUsers can specify the export destination, format (currently only MP4), and priority of the task.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific IAM permissions and OAuth scopes for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses a POST request to \u003ccode\u003ehttps://earthengine.googleapis.com/v1/{project=projects/*}/video:export\u003c/code\u003e with defined request and response structures.\u003c/p\u003e\n"],["\u003cp\u003eProvides options to customize the video generation process through \u003ccode\u003evideoOptions\u003c/code\u003e and export parameters through \u003ccode\u003efileExportOptions\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.video.export\n\nInitiates a batch process that computes a video and writes the result to one of several destinations.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1/{project=projects/*}/video:export`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `project` | `string` The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is `projects/{project-id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `project`: - `earthengine.exports.create` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"expression\": { object (/earth-engine/reference/rest/v1/Expression) }, \"description\": string, \"videoOptions\": { object (/earth-engine/reference/rest/v1/projects.locations.videoThumbnails#VideoThumbnail.VideoOptions) }, \"fileExportOptions\": { object (/earth-engine/reference/rest/v1/projects.video/export#VideoFileExportOptions) }, \"requestId\": string, \"workloadTag\": string, \"priority\": integer } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `expression` | `object (`[Expression](/earth-engine/reference/rest/v1/Expression)`)` An expression that evaluates to the video to compute and export, represented as an image collection. |\n| `description` | `string` A human-readable name of the task. |\n| `videoOptions` | `object (`[VideoOptions](/earth-engine/reference/rest/v1/projects.locations.videoThumbnails#VideoThumbnail.VideoOptions)`)` Basic options describing the video to generate. |\n| `fileExportOptions` | `object (`[VideoFileExportOptions](/earth-engine/reference/rest/v1/projects.video/export#VideoFileExportOptions)`)` Options for where and in what form to export the video. |\n| `requestId` | `string` A unique string used to detect duplicated requests. If more than one request is made by the same user with the same non-empty `requestId`, only one of those requests may successfully start a long-running operation. `requestId` may contain the characters a..z, A..Z, 0-9, or '-'. `requestId` may be at most 60 characters long. |\n| `workloadTag` | `string` User supplied label to track this computation. |\n| `priority` | `integer` Optional. The priority of the export task within the project. Higher priority tasks are scheduled sooner. Must be an integer between 0 and 9999. Defaults to 100 if not set. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Operation).\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/cloud-platform`\n- `\n https://www.googleapis.com/auth/devstorage.full_control`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nVideoFileExportOptions\n----------------------\n\nOptions for exporting videos as files outside Earth Engine.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"fileFormat\": enum (/earth-engine/reference/rest/v1/projects.locations.videoThumbnails#VideoThumbnail.VideoFileFormat), // Union field `destination` can be only one of the following: \"driveDestination\": { object (/earth-engine/reference/rest/v1/DriveDestination) }, \"cloudStorageDestination\": { object (/earth-engine/reference/rest/v1/CloudStorageDestination) } // End of list of possible types for union field `destination`. } ``` |\n\n| Fields ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fileFormat` | `enum (`[VideoFileFormat](/earth-engine/reference/rest/v1/projects.locations.videoThumbnails#VideoThumbnail.VideoFileFormat)`)` The file format in which to export the video(s). Currently only MP4 is supported. |\n| Union field `destination`. Where to write the results. `destination` can be only one of the following: ||\n| `driveDestination` | `object (`[DriveDestination](/earth-engine/reference/rest/v1/DriveDestination)`)` If specified, configures export to Google Drive. |\n| `cloudStorageDestination` | `object (`[CloudStorageDestination](/earth-engine/reference/rest/v1/CloudStorageDestination)`)` If specified, configures export to Google Cloud Storage. |"]]