WorldView 3D Parameters
WorldView 3D tasking is the equivalent of placing a WorldView 2D FlexView tasking request for stereo image coverage, and then ordering a WorldView 3D elevation product from the resulting pair of images. WorldView 3D tasking steamlines this into a single request.
They share similar request payloads with some key differences:
- To capture two overlapping images with the correct geometry, you cannot specify detailed collection parameters.
- AOI requirements are different because the AOI must fit within overlapping scenes.
- WorldView 3D product parameters are limited to stereo shadow infill only.
Required fields are denoted by an asterisk.
Query parameters
| Query parameter | Description | Example |
|---|---|---|
validation_only | Validate a request before sending. | /tasking/rapid3d?validation_only=true |
General collection parameters
These parameters control the where and when of the collection.
| Parameter | Type | Description | Allowed Values | Example |
|---|---|---|---|---|
geometry* | object | A GeoJSON Polygon geometry. | Must be a rectangle within size requirements. | See AOIs |
start_collect_datetime* | string | The date and time the requested imagery collection can start. | ISO-8601 Dates or now. Date and time can not be in the past. | "start_collect_datetime": "2026-05-01 18:34:57Z" |
end_collect_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_collect_datetime and within 364 days of placing the request. | "end_collect_datetime": "2026-04-30 18:34:57Z" |
request_description | string | Optional description. | "request_description": "Albuquerque" | |
stereo | string | While not required, this is considered a stereo collection and is always true. | ||
tasking_tier | string | Only FlexView tasking is supported currently so this field is only flexView. | ||
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 WorldView 3D ordering | 3dsm, dsm, 3dbundle, | "product_type": "3dbundle" |
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" |
infill_stereo_shadow | boolean | Stereo Shadow Infill is always applied. This value is only true | |||
vertical_system | string | Vertical system for ordering DSM. | |||
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.
Path variables
To insert the Tasking ID automatically into an output path, use the $.tasking_id variable.
{
"type": "amazon_s3",
"bucket": "my-tasking-bucket",
"prefix": "deliveries/$.tasking_id"
}
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.
The end date must be later than the start date and both must be 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"
WorldView 3D can also accept a start_collect_datetime of now to start the collection window immediately.
AOIs
The AOI must be a GeoJSON Polygon following these guidelines:
- Maximum area: 1000 sq km.
- Minimum area: 40 sq km.
- Width must be between 5 and 10 km.
- Length must be between 8 and 100 km.
- Polygon must be a rectangle oriented north-south.
Modifying the end date of a WorldView 3D tasking request
The end date for a WorldView 3D tasking request can be modified before collection starts.The request must be in the ACCEPTED state to be modified. See the similar Patch WorldView 3D Tasking for the request format.
End date is the only parameter that can be modified. To change other parameters of a WorldView 3D request, cancel your existing request and submit a new one.
This request is for WorldView 3D and FlexView orders only. FastView and Umbra orders cannot be extended.
Canceling a WorldView 3D request
WorldView 3D requests must be canceled before collection starts. See Cancel a Tasking request