Working with Imagery Product Types via API
API Developers / Integrators: Learn how to configure, update, and manage imagery product types for tasking and archive orders using the API.
Overview
The API allows full control over imagery product types in both tasking requests and archive orders. You can:
-
Set imagery product types during task creation
-
Update them before collection
-
Configure organization-wide defaults
-
Order additional imagery product types from the archive
The GEO product type is required in all tasking requests.
1. Tasking with Imagery Product Types
When creating a tasking request, specify the desired imagery product types in the processingConfig.productTypes
field.
Request Example
"contractId": "<contract-id>",
"type": "Feature",
"geometry": {
"coordinates": [<longitude>, <latitude>],
"type": "Point"
},
"properties": {
"processingConfig": {
"productTypes": [
"GEO",
"SICD",
"GEC",
"SLC"
]
},
"taskingrequestName": "<name>",
"taskingrequestDescription": "<description>",
"windowOpen": "<windowOpen>",
"windowClose": "<windowClose>",
"collectionTier": "<collectionTier>",
"collectionType": "<collectionType>",
"collectConstraints": {
"localTime": "<localTime>",
"offNadirMin": <offNadirMin>,
"offNadirMax": <offNadirMax>,
"polarization": "<polarization>",
"azimuthAngleMin": <azimuthAngleMin>,
"azimuthAngleMax": <azimuthAngleMax>
},
"archiveHoldback": "<archiveHoldback>"
}
}
GEO
is mandatory and must always be included.2. Updating Imagery Product Types for an Existing Task
Imagery product types can be updated via PATCH
up to 3 hours before the expected collection time.
Request Example
PATCH /tasks/{id}
{
"properties": {
"processingConfig": {
"productTypes": [
"GEC",
"SLC",
"GEO",
"SICD"
]
}
}
}
3. Setting Default Product Types for Your Organization
Org Managers can set organization-wide defaults. These defaults influence which product types are pre-selected for all new tasking requests submitted by users in the org.
-
required: true
– always included, not editable by users -
required: false
– pre-selected but user-editable
Request Example
PUT /organizations/{id}
{
"defaultProductTypes": [
{
"productType": "GEO",
"required": true
},
{
"productType": "SLC",
"required": false
}
]
}
4. Ordering Additional Imagery Product Types from Archive
If a product type was not originally requested during tasking, it can be added later via an archive order.
Step 1: Review the Order
"items": [
{
"productType": "GEC",
"collectIds": [
"798ffc87-5b7b-4786-8611-42c23fc2a95f"
]
}
]
}
Step 2: Create the Order
"items": [
{
"productType": "GEC",
"collectIds": [
"798ffc87-5b7b-4786-8611-42c23fc2a95f"
]
}
]
}
Additional Notes
-
Product types marked as unavailable by the Org Manager will be rejected in tasking requests.
-
Use
/organizations/{id}
to programmatically inspect or update your org’s product type configuration. -
Refer to the Product Type Glossary for descriptions and use cases of each imagery product type.