Fastview Parameters
NOTE Tasking API V2 is in final development and review. This draft documentation is subject to change at any time.
While Flexview and Fastview tiers share some field names, the restrictions on field values can vary.
Note: Required fields are denoted by an asterisk.
Query parameters
| Query parameter | Description | Example |
|---|---|---|
validation_only | Validate a request before sending. For "Fastview" requests, validation includes a check to see if the requested start_datetime is available. | /tasking/vantor?validation_only=true |
A validation_only request will tell you if the requested start date is available at the time the request is made. It does not reserve the time. To reserve your start date, submit a POST Tasking request.
If the request start date and time are not available, the validation_only request will return a 400 BAD Request error, with a list of available start dates.
General collection parameters
These parameters control the where and when of the collection.
| Parameter | Type | Description | Allowed Values | Example |
|---|---|---|---|---|
tasking_tier* | string | See Tiers in the Tasking Guide. | fastView | "tasking_tier": "fastView" |
geometry* | object | A general AOI represented by a target center point and buffer. | See AOIs | |
start_datetime* | string | ISO-8601 formatted The date and time the requested imagery collection can start. | Must occur at least 8 hours into the future and no further than 14 days after the submitted start date. | "start_datetime": "2025-05-01 18:34:57Z" |
request_description | string | Optional description. | "request_description": "Albuquerque" |
Note: Fastview does not have a concept of "end datetime", since it guarantees an image within 24 hours of
start_datetime. This image will be collected regardless of visibility. It is your responsibility to monitor weather and other atmospheric conditions over your area.
Detailed collection parameters
The tasking_details object controls more specific collection parameters.
| Parameter | Type | Description | Allowed Values | Default Value | Example |
|---|---|---|---|---|---|
max_gsd* | number | The size of a single pixel as measured on the ground. This is also referred to as “resolution”. State the requested ground sample distance for the collection (meters). | [0.39, 0.59] | N/A | "max_gsd": 0.39 |
max_off_nadir_angle | number | The off-nadir angle is how much the satellite’s camera is tilted when looking straight down. If the camera looks directly below the satellite, that’s called ‘nadir’ (0°). But if it’s angled to the side to capture an image farther away, that angle is the off-nadir angle. We recommend setting the maximum allowed off-nadir angle to 30 degrees or less in most cases. | 5-45 (inclusive). | 30 | "max_off_nadir_angle": 30 |
min_target_azimuth_angle | number | Target azimuth is the direction the satellite is looking when it captures an image. It affects how the scene appears—things like the angle of buildings, the direction of shadows, and what features are more or less visible.. Use this field to set the minimum target azimuth angle for the collection. | 0-360 (inclusive) | 0 | "min_target_azimuth_angle": 90 |
max_target_azimuth_angle | number | Target azimuth is the direction the satellite is looking when it captures an image. It affects how the scene appears—things like the angle of buildings, the direction of shadows, and what features are more or less visible. Use this field to set maximum target azimuth angle for the collection. | 0-360 (inclusive) | 360 | "max_target_azimuth_angle": 180 |
Product parameters
The product_details object contains specifications related to the delivered products.
| Parameter | Type | Description | Allowed Values | Default Value | Example |
|---|---|---|---|---|---|
product_type* | string | Output product format | Matches pipeline names from Archive ordering | system-ready, view-ready, view-ready-ortho, map-ready | "product_type": "view-ready-ortho" |
licensing* | object | Licensing details | |||
licensing.end_use_code* | string | This is the intended use of the ordered imagery. If the code "OTH" is used, the end use description field must also be included. | See End use codes | N/A | "end_use_code": "AGR" |
licensing.end_use_description | string | Required if end_use_code = "OTH". Not allowed for any other end use code. Describe the intended use of the ordered imagery. | Between 1-50 characters. | N/A | "end_use_description": "evaluation" |
The following product options can be changed:
product_optionresampling_kerneltilingfile_formatdynamic_range_adjustmentacompcompressionoutput_bit_depthproduct_licensing
The accepted values for these options varies based on the product_type selected. For more information on these options see Archive Imagery Product Type Information.
Configuring output locations
Outputs can be specified using the same options as used by the Ordering API.
| Parameter | Type | Description |
|---|---|---|
output_configs | array | Sets the location(s) for delivering collected imagery. |
See Ordering Output Delivery Options in the Ordering section.
Notifications
| Parameter | Type | Description |
|---|---|---|
notifications | array | Sets targets to be notified when the status of the request is updated. |
See Tasking notifications for options.
Date and time formats
The collection time frame is determined by the start date and the end date. Both are required.
start_datetimemust be set at least 5 minutes in the future.end_datetimemust be set at least 10 minutes in the future.
"start_datetime": "2025-01-01T00:00:00Z",
"end_datetime": "2025-03-01T00:00:00Z",
Dates must use ISO 8601 standards and must specify a time zone designator of either UTC or an offset from UTC.
The following are all valid datetime formats.
"2024-04-02T00:00Z"
"2024-04-02T00:00:00Z"
"20240402T00:00+0000"
"2024-04-02T4:00+04:00"
"2024-04-02T04:00+04:00"
"2024-04-01T22:00-02"
AOIs
AOIs for Fastview are described by a center point and buffer. Theses are represented in three fields:
latitude: as decimal degrees, numeric type.longitude: as decimal degrees, numeric type.buffer: One of the following strings, representing width and height in kilometers:8x82x50,5x10,5x20
Canceling a Fastview request
Fastview tasking requests cannot be modified. To change your Fastview request, cancel your existing request and submit a new one. Fastview requests can be canceled up to 24 hours before the start date. See Cancel a Tasking request.