Flexview 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.	/tasking/vantor?validation_only=true

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.	flexView	"tasking_tier": "flexView"
geometry*	object	A GeoJSON Polygon geometry.	Maximum 1000 vertices, spaced at least 1 - 2 m apart.	See AOIs
start_datetime*	string	ISO-8601 formatted The date and time the requested imagery collection can start.	Must occur at least 24 hours in the future	"start_datetime": "2025-05-01 18:34:57Z"
end_datetime*	string	ISO-8601 formatted The date and time the imagery collection request will expire.	The end date and time must occur at least ten minutes after start_datetime and within 364 days of placing the request.	"end_datetime": "2026-04-30 18:34:57Z"
request_description	string	Optional description.		"request_description": "Albuquerque"

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_cloud_cover	number	"Cloud cover" is the percentage of the image strip that is covered by clouds. Use this field to set to set the maximum percentage of cloud cover allowed for your collection.	15-50 (inclusive)	15	"max_cloud_cover": 20
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_sun_elevation_angle	number	The Sun elevation angle is how high the Sun is in the sky. If the Sun is directly overhead, the angle is 90°. If it's near the horizon, the angle is lower. A lower Sun angle creates longer shadows, while a higher Sun angle makes shadows shorter. The minimum sun elevation for a collection is 15 degrees. Use this field to set the minimum sun elevation allowed for your collection.	15-90 (inclusive)	15	"min_sun_elevation_angle": 25
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_option
• resampling_kernel
• tiling
• file_format
• dynamic_range_adjustment
• acomp
• compression
• output_bit_depth
• product_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_datetime must be set at least 5 minutes in the future.
• end_datetime must 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

The AOI must be a GeoJSON Polygon with less than 1000 vertices. GeoJSON MultiPolygons and Features are not accepted.

The AOI must also meet these constraints:

• Maximum area: 1000 sq km.
• Minimum area:
  • High demand areas: 64 sq km.
  • Low demand areas 50 sq km.
• Width must exceed 2 km.

Modifying the end date of a Flexview tasking request

The end date for a Flexview tasking request can be modified before collection starts. To modify the end date, see Patch Flexview Tasking.

End date is the only parameter that can be modified. To change other parameters of a Flexview request, cancel your existing request and submit a new one.

Important: This request is for Flexview requests only. Fastview orders cannot be modified.

Canceling a Flexview request

Flexview requests must be canceled before collection starts. See Cancel a Tasking request.