Method: videos.lookupVideo
Stay organized with collections
Save and categorize content based on your preferences.
Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.
HTTP request
GET https://aerialview.googleapis.com/v1/videos:lookupVideo
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
Union parameter key. Required. A key used to look-up a video. key can be only one of the following: |
videoId |
string
An ID returned from videos.renderVideo.
|
address |
string
A US postal address.
|
Request body
The request body must be empty.
Response body
An object that encapsulates all of the data about a video.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"uris": {
string: {
object (Uris)
},
...
},
"state": enum (State),
"metadata": {
object (VideoMetadata)
}
} |
| Fields |
uris |
map (key: string, value: object (Uris))
A mapping of media types to their URIs. This field is only included for ACTIVE videos. The key is an enum value from MediaFormat. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
state |
enum (State)
Current state of the render request.
|
metadata |
object (VideoMetadata)
Contains the video's metadata, only set if the state is ACTIVE.
|
Uris
Contains all the uris for a given video format.
| JSON representation |
{
"landscapeUri": string,
"portraitUri": string
} |
| Fields |
landscapeUri |
string
A signed short-lived URI for the media in a landscape orientation.
|
portraitUri |
string
A signed short-lived URI for the media in a portrait orientation.
|
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-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003eFetches a video using its address or videoId, returning playback URIs for active videos or a processing state for pending ones.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a set of URIs for different media types if the video is active, along with its current state and metadata.\u003c/p\u003e\n"],["\u003cp\u003eA 404 error is returned if the video does not exist, and receiving a video is a billable event.\u003c/p\u003e\n"],["\u003cp\u003eThe request utilizes a \u003ccode\u003eGET\u003c/code\u003e method with the endpoint \u003ccode\u003ehttps://aerialview.googleapis.com/v1/videos:lookupVideo\u003c/code\u003e and requires either a \u003ccode\u003evideoId\u003c/code\u003e or \u003ccode\u003eaddress\u003c/code\u003e as a query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe response body provides the video's URIs (if active), state, and metadata.\u003c/p\u003e\n"]]],["The core action is fetching a video using a `GET` request to `https://aerialview.googleapis.com/v1/videos:lookupVideo`. The request requires a `key` parameter, either a `videoId` or an `address`. The request body must be empty. A successful response returns a video object with `uris`, `state`, and `metadata`. `uris` map media types to URIs, `state` indicates the video's status, and `metadata` contains video details. The video can also be in `PROCESSING` or result in a 404 error.\n"],null,["# Method: videos.lookupVideo\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Video.SCHEMA_REPRESENTATION)\n- [Uris](#Uris)\n - [JSON representation](#Uris.SCHEMA_REPRESENTATION)\n\nFetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.\n\n### HTTP request\n\n`GET https://aerialview.googleapis.com/v1/videos:lookupVideo`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------|----------------------------------------------------|\n| Union parameter `key`. Required. A key used to look-up a video. `key` can be only one of the following: ||\n| `videoId` | `string` An ID returned from `videos.renderVideo`. |\n| `address` | `string` A US postal address. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nAn object that encapsulates all of the data about a video.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"uris\": { string: { object (/maps/documentation/aerial-view/reference/rest/v1/videos/lookupVideo#Uris) }, ... }, \"state\": enum (/maps/documentation/aerial-view/reference/rest/v1/State), \"metadata\": { object (/maps/documentation/aerial-view/reference/rest/v1/VideoMetadata) } } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `uris` | `map (key: string, value: object (`[Uris](/maps/documentation/aerial-view/reference/rest/v1/videos/lookupVideo#Uris)`))` A mapping of media types to their URIs. This field is only included for `ACTIVE` videos. The key is an enum value from `MediaFormat`. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `state` | `enum (`[State](/maps/documentation/aerial-view/reference/rest/v1/State)`)` Current state of the render request. |\n| `metadata` | `object (`[VideoMetadata](/maps/documentation/aerial-view/reference/rest/v1/VideoMetadata)`)` Contains the video's metadata, only set if the state is `ACTIVE`. |\n\nUris\n----\n\nContains all the uris for a given video format.\n\n| JSON representation |\n|-----------------------------------------------------------|\n| ``` { \"landscapeUri\": string, \"portraitUri\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------|\n| `landscapeUri` | `string` A signed short-lived URI for the media in a landscape orientation. |\n| `portraitUri` | `string` A signed short-lived URI for the media in a portrait orientation. |"]]
