AxelGlobe Tasking API (2.0.6)

Download OpenAPI specification:Download

AxelGlobe Tasking API

The AxelGlobe Tasking API allows for automation of our satellite tasking process. You can request a specific area of interest be captured at a specific date and time.

Status

Beta

Terms

List of terms used in the API

Term Meaning
AOI Area of Interest. Some geographic area (Polygon) representing the area that is interested in being captures by a satellite.
Capture A single image taken by a satellite
Task Candidate Information about a possible future capture. Will have a specific area (footprint) and capture time.
Task Plan A combination of an AOI and TOI used to plan possible satellite captures. Task plans are just information for planning and do not automatically schedule captures.
Task Request A request to schedule a capture. This will consume a Task Credit and we will make a best effort to schedule a satellite to take a capture matching the requested Candidate.
TOI Time of Interest. Some time range that a Task Plan is valid for. Note this can not be created too far in the future.

API Overview

The structure of the AxelGlobe Tasking API follows the OGC API "Features" standard. Each collection of features are represented as GeoJSON.

The typical tasking workflow has the following steps:

  1. Authenticate
  2. Create a Task Plan
  3. Review list of Task Candidates
  4. Request Task be scheduled
  5. Check Task status and download data

Step 1: Authenticate

Before connecting to the API you must generate a Token with credentials from our platform. Please contact us for more information about API access.

Use the Create an authorization Token request to generate a token. Securely store this token locally for up to 24 hours. Use this token for all subsequent requests in a session. After the token expires you can request a new one.

Step 1: Create a Task Plan

To get started tasking you have to plan a capture. This will allow our system to generate capture candidates that have been calculated and validated so they can be scheduled.

To create a Task Plan make a POST request to the Create Task Plan endpoint.

Note the validation rules for a Task Plan in the request body schema below.

Step 3: Review list of Task Candidates

Once the Task Plan is created our system will take up to 3 hours to generate validated Task Candidates.

After waiting 3 hours then list all the candidates using the List Candidates endpoint. This endpoint is paginated, and a the full list can be fetched by following the links with of type rel=next.

Note: if the list of candidates is empty after 3 or more hours then we are not able to capture the planned AOI or TOI.

At this point any of the Candidates are able to be tasked. Review the list and decide on the optimal Task Candidate that fits your needs.

Step 4: Request Task be scheduled

To schedule a Task Candidate create a Task Request using the Create Task request endpoint.

Provide the ID of the Candidate and the priority of the Task.

Note: this must be done within the lifetime of a Candidate (within approximately 3 hours after the candidate was created). If the Candidate is expired then fetch the list Candidate again to get fresh ones.

Step 5: Check Task status and download data

After the Task Request is accepted you can check the status of the Request. Use the Task Request Details endpoint to check the status of the Request.

We recommend polling the API approximately once per hour to check for status updates. Once the status becomes DATA_AVAILABLE there will be a link to our STAC API with all the data from the capture. Generally data will be available 24-48 hours after the capture.

Authentication

To use the API you need to create a Token with our authentication server.

This token should be reused between requests until it expires.

Create an authorization Token

how to get token

Authorizations:
None
Request Body schema: application/json
required

Authorize Token

grant_type
required
string
Value: "client_credentials"
audience
required
string
Value: "https://api.axelglobe.com"
client_id
required
string

Client ID provided by the AxelGlobe platform. Do not share this information with anyone.

client_secret
required
string

Client Secret provided by the AxelGlobe platform. Do not share this information with anyone.

Responses

Response Schema: application/json
access_token
required
string <JWT>

Token to use when accessing the AxelGlobe Tasking API

expires_in
required
integer

Length of time in seconds from generation time that the token will be valid

token_type
required
string
Value: "Bearer"

Request samples

Content type
application/json
{
  • "grant_type": "client_credentials",
  • "client_id": "ABCDEF00000000000",
  • "client_secret": "SECRET_VALUE"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.iUCROHt6JHANdtzT6aOuUgOqVFRalOW20SbzRsn5SkI",
  • "expires_in": 86400,
  • "token_type": "Bearer"
}

Capabilities

OCC Spatial Data on the Web Best Practices

Landing Page

Follows OGC API - Features (WFS 3) Part-1 Core: 7.2.

Authorizations:
oauth_token

Responses

Response Schema: application/json
title
required
string
description
required
string
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Request samples

curl https://sandbox-api.axelglobe.com/wfs/tasking/v2/ \
-H "Authorization: Bearer {{oauth_token}}""

Response samples

Content type
application/json
{
  • "title": "The AxelGlobe Tasking API",
  • "description": "Access to the tasking capabilities on the AxelGlobe via a REST API",
  • "links": [
    ]
}

Conformance information

Follows OGC API - Features (WFS 3) Part-1 Core: 7.2.

Authorizations:
oauth_token

Responses

Response Schema: application/json
conformsTo
Array of strings

Collections information

Follows OGC API - Features (WFS 3) Part-1 Core: 7.2.

Authorizations:
oauth_token

Responses

Response Schema: application/json
required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
required
Array of objects (collection)
Array
id
required
string
Enum: "satellites" "plans" "candidates" "requests"
title
string
description
string
itemType
string
Value: "feature"
object (extent)

The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges.

object

The spatial extent of the features in the collection.

object

The temporal extent of the features in the collection.

crs
Array of strings
Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]

the list of coordinate reference systems supported by the service

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/json
{}

Satellites

Satellites Metadata

Authorizations:
oauth_token

Responses

Response Schema: application/json
id
string
Value: "satellites"
title
string
description
string
itemType
string
Value: "feature"
object (extent)

The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges.

object

The spatial extent of the features in the collection.

bbox
Array of numbers non-empty [ items [ 4 .. 6 ] items ]

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported. Extensions may support additional areas. If multiple areas are provided, the union of the bounding boxes describes the spatial extent.

crs
string
Default: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
Value: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"

Coordinate reference system of the coordinates in the spatial extent (property bbox). The default reference system is WGS 84 longitude/latitude. In the Core this is the only supported coordinate reference system. Extensions may support additional coordinate reference systems and add additional enum values.

object

The temporal extent of the features in the collection.

interval
Array of null or strings non-empty [ items <date-time > = 2 items [ items <date-time > ] ]

One or more time intervals that describe the temporal extent of the dataset. The value null is supported and indicates an open time intervall. In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent.

trs
string
Default: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
Value: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"

Coordinate reference system of the coordinates in the temporal extent (property interval). The default reference system is the Gregorian calendar. In the Core this is the only supported temporal reference system. Extensions may support additional temporal reference systems and add additional enum values.

crs
Array of strings
Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]

the list of coordinate reference systems supported by the service

Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/json
{}

Describe Tasks Plans

Task Plans Metadata

Authorizations:
oauth_token

Responses

Response Schema: application/json
id
string
title
string
description
string
itemType
string
Value: "feature"
object (extent)

The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges.

object

The spatial extent of the features in the collection.

bbox
Array of numbers non-empty [ items [ 4 .. 6 ] items ]

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported. Extensions may support additional areas. If multiple areas are provided, the union of the bounding boxes describes the spatial extent.

crs
string
Default: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
Value: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"

Coordinate reference system of the coordinates in the spatial extent (property bbox). The default reference system is WGS 84 longitude/latitude. In the Core this is the only supported coordinate reference system. Extensions may support additional coordinate reference systems and add additional enum values.

object

The temporal extent of the features in the collection.

interval
Array of null or strings non-empty [ items <date-time > = 2 items [ items <date-time > ] ]

One or more time intervals that describe the temporal extent of the dataset. The value null is supported and indicates an open time intervall. In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent.

trs
string
Default: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
Value: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"

Coordinate reference system of the coordinates in the temporal extent (property interval). The default reference system is the Gregorian calendar. In the Core this is the only supported temporal reference system. Extensions may support additional temporal reference systems and add additional enum values.

crs
Array of strings
Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]

the list of coordinate reference systems supported by the service

Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/json
{}

Describe Candidates

candidates Metadata

Authorizations:
oauth_token

Responses

Response Schema: application/json
id
string
title
string
description
string
itemType
string
Value: "feature"
object (extent)

The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges.

object

The spatial extent of the features in the collection.

bbox
Array of numbers non-empty [ items [ 4 .. 6 ] items ]

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported. Extensions may support additional areas. If multiple areas are provided, the union of the bounding boxes describes the spatial extent.

crs
string
Default: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
Value: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"

Coordinate reference system of the coordinates in the spatial extent (property bbox). The default reference system is WGS 84 longitude/latitude. In the Core this is the only supported coordinate reference system. Extensions may support additional coordinate reference systems and add additional enum values.

object

The temporal extent of the features in the collection.

interval
Array of null or strings non-empty [ items <date-time > = 2 items [ items <date-time > ] ]

One or more time intervals that describe the temporal extent of the dataset. The value null is supported and indicates an open time intervall. In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent.

trs
string
Default: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
Value: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"

Coordinate reference system of the coordinates in the temporal extent (property interval). The default reference system is the Gregorian calendar. In the Core this is the only supported temporal reference system. Extensions may support additional temporal reference systems and add additional enum values.

crs
Array of strings
Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]

the list of coordinate reference systems supported by the service

Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/json
{}

Describe Task Requests

Task Request Metadata

Authorizations:
oauth_token

Responses

Response Schema: application/json
id
string
Value: "requests"
title
string
description
string
itemType
string
Value: "feature"
object (extent)

The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges.

object

The spatial extent of the features in the collection.

bbox
Array of numbers non-empty [ items [ 4 .. 6 ] items ]

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported. Extensions may support additional areas. If multiple areas are provided, the union of the bounding boxes describes the spatial extent.

crs
string
Default: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
Value: "http://www.opengis.net/def/crs/OGC/1.3/CRS84"

Coordinate reference system of the coordinates in the spatial extent (property bbox). The default reference system is WGS 84 longitude/latitude. In the Core this is the only supported coordinate reference system. Extensions may support additional coordinate reference systems and add additional enum values.

object

The temporal extent of the features in the collection.

interval
Array of null or strings non-empty [ items <date-time > = 2 items [ items <date-time > ] ]

One or more time intervals that describe the temporal extent of the dataset. The value null is supported and indicates an open time intervall. In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent.

trs
string
Default: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
Value: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"

Coordinate reference system of the coordinates in the temporal extent (property interval). The default reference system is the Gregorian calendar. In the Core this is the only supported temporal reference system. Extensions may support additional temporal reference systems and add additional enum values.

crs
Array of strings
Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]

the list of coordinate reference systems supported by the service

Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/json
{}

Satellites

Information about our satellite constellation

List Satellites

List AxelGlobe Satellites

Authorizations:
oauth_token
query Parameters
limit
number <integer> [ 1 .. 20 ]
Default: 10

Result pagination limit

offset
number <integer> >= 1

Result pagination offset

Responses

Response Schema: application/geo+json
type
required
string
Value: "FeatureCollection"
required
Array of objects (Satellite)
Array
type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
id
required
string
required
object
platform
required
string

Name of the satellite. Matches the platform STAC property

international_designator
required
string

International Designator (COSPAR ID) of the satellite.

instruments
required
Array of strings
Items Value: "msi"
gsd
required
number <float>

Ground sample distance [m/px]

required
Array of objects
sat:orbit_state
required
string
Enum: "ascending" "descending"
required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
numberMatched
required
number <integer>

Response samples

Content type
application/geo+json
{}

Satellite Details

Satellite Information

Authorizations:
oauth_token
path Parameters
satelliteId
required
string
Example: grus-1b

unique identifier for a Satellite

Responses

Response Schema: application/geo+json
type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
id
required
string
required
object
platform
required
string

Name of the satellite. Matches the platform STAC property

international_designator
required
string

International Designator (COSPAR ID) of the satellite.

instruments
required
Array of strings
Items Value: "msi"
gsd
required
number <float>

Ground sample distance [m/px]

required
Array of objects
Array
name
required
string
common_name
required
string
center_wavelength
required
number <float>
full_width_half_max
number <float>
solar_illumination
number <float>
sat:orbit_state
required
string
Enum: "ascending" "descending"

Response samples

Content type
application/geo+json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "id": "GRUS-1B",
  • "properties": {
    }
}

Task Plans

Register an AOI to plan a capture

Create a Task Plan to get information about potential captures.

Task Plan Status

After creating a Plan it can take a few hours for candidates to be generated.

When a Plan has status ACTIVE then you can check for possible candidates using the rel=candidates link in the Plan response.

List Task Plans

List your task plans

Authorizations:
oauth_token
query Parameters
limit
number <integer> [ 1 .. 20 ]
Default: 10

Result pagination limit

offset
number <integer> >= 1

Result pagination offset

Responses

Response Schema: application/geo+json
type
required
string
Value: "FeatureCollection"
required
Array of objects (Task Plan)
Array
type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
id
required
string
required
object
created
required
string <date-time>
name
required
string
valid_start
required
string <date-time>
valid_end
required
string <date-time>
off_nadir_range
required
Array of numbers <double> = 2 items [ items <double > [ 0 .. 15 ] ]
Default: [0,15]
satellites
required
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"
status
required
string
Enum: "PROCESSING" "ACTIVE" "EXPIRED" "CANCELLED"

Plans can take a few hours to finish candidates processing. Active plans have finished processing and are in their valid time window. Expired Plans are past their valid time window.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
numberMatched
required
number <integer>

Response samples

Content type
application/geo+json
{}

Create Task Plan

Create a new Task Plan Provide a Name, AOI and TOI. After 3 hours the system will generate Candidates for the Task Plan.

Authorizations:
oauth_token
Request Body schema: application/geo+json
required

Create a new Task Plan

type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
required
object
name
required
string [ 1 .. 64 ] characters ^(?=.*[ -~])(?!.*[.~|\/${}%\\]).*$
valid_start
required
string <date-time>

Start date of Time of Interest for the Task.

valid_end
required
string <date-time>

End date of Time of Interest for the Task.

off_nadir_range
Array of numbers <double> = 2 items [ items <double > [ 0 .. 15 ] ]
Default: [0,15]

Optional range of acceptable off-nadir angles for the Task.

satellites
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"

Optional list of acceptable satellites to use for the Task.

Responses

Response Schema: application/geo+json
type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
id
required
string
required
object
created
required
string <date-time>
name
required
string
valid_start
required
string <date-time>
valid_end
required
string <date-time>
off_nadir_range
required
Array of numbers <double> = 2 items [ items <double > [ 0 .. 15 ] ]
Default: [0,15]
satellites
required
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"
status
required
string
Enum: "PROCESSING" "ACTIVE" "EXPIRED" "CANCELLED"

Plans can take a few hours to finish candidates processing. Active plans have finished processing and are in their valid time window. Expired Plans are past their valid time window.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Request samples

Content type
application/geo+json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/geo+json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "id": "VGFza1BsYW46MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
  • "properties": {
    },
  • "links": []
}

Task Plan Details

Data about a Task plan

Authorizations:
oauth_token
path Parameters
taskPlanId
required
string

unique identifier for a Task Plan

Responses

Response Schema: application/geo+json
type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
id
required
string
required
object
created
required
string <date-time>
name
required
string
valid_start
required
string <date-time>
valid_end
required
string <date-time>
off_nadir_range
required
Array of numbers <double> = 2 items [ items <double > [ 0 .. 15 ] ]
Default: [0,15]
satellites
required
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"
status
required
string
Enum: "PROCESSING" "ACTIVE" "EXPIRED" "CANCELLED"

Plans can take a few hours to finish candidates processing. Active plans have finished processing and are in their valid time window. Expired Plans are past their valid time window.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/geo+json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "id": "VGFza1BsYW46MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
  • "properties": {
    },
  • "links": []
}

Invalidate Task Plan

Cancel a Task Plan

Authorizations:
oauth_token
path Parameters
taskPlanId
required
string

unique identifier for a Task Plan

Responses

Response samples

Content type
application/json
""

Task Candidates

A Task Candidate is one calculated potential scene related to a Task Plan

List Candidates

List candidates for a Task Plan. This must be filtered to a Task Plan ID using the CQL2 Filter syntax.

Task Candidates have a similar structure to STAC Items. Review the scene footprints and properties to decide the optimal capture for your use case.

Example:

  • GET /wfs/tasking/v2/collections/candidates/items?filter=task_plan_id+=+'VGFza1BsYW46MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw'
Authorizations:
oauth_token
query Parameters
filter
required
string
Example: filter=task_plan_id = 'VGFza1BsYW46MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw'

CQL2 Syntax filter. Must include a filter to a Task Plan by ID.

limit
number <integer> [ 1 .. 100 ]
Default: 10

Result pagination limit

offset
number <integer> >= 1

Result pagination offset

Responses

Response Schema: application/geo+json
type
required
string
Value: "FeatureCollection"
required
Array of objects (Task Candidate)
Array
type
required
string
Value: "Feature"
id
required
string
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
required
object
task_plan_id
string

The original Task Plan that this Candidate is for

view:off_nadir
required
number <double> [ 0 .. 90 ]

The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90)

view:sun_elevation
required
number <double> [ -90 .. 90 ]

Sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90)

view:sun_azimuth
required
number <double> [ 0 .. 360 ]

Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).

plan_coverage
required
number <double> [ 0 .. 100 ]

Percentage of the Task Plan AOI this candidate footprint covers. Measured in percent (0-100).

start_datetime
required
string <date-time>

Time the candidate capture is expected to start

end_datetime
required
string <date-time>

Time the candidate capture is expected to end

platform
required
string
Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"

Satellite that will take the capture

constellation
required
string
Value: "GRUS1"
valid_until
required
string <date-time>

Time in the future this candidate will no longer be valid to schedule. Please schedule the candidate before this date.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
numberMatched
required
number <integer>

Response samples

Content type
application/geo+json
{}

Task Candidate Details

Data about a Candidate

Authorizations:
oauth_token
path Parameters
candidateId
required
string

unique identifier for a Task Candidate

Responses

Response Schema: application/geo+json
type
required
string
Value: "Feature"
id
required
string
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
required
object
task_plan_id
string

The original Task Plan that this Candidate is for

view:off_nadir
required
number <double> [ 0 .. 90 ]

The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90)

view:sun_elevation
required
number <double> [ -90 .. 90 ]

Sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90)

view:sun_azimuth
required
number <double> [ 0 .. 360 ]

Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).

plan_coverage
required
number <double> [ 0 .. 100 ]

Percentage of the Task Plan AOI this candidate footprint covers. Measured in percent (0-100).

start_datetime
required
string <date-time>

Time the candidate capture is expected to start

end_datetime
required
string <date-time>

Time the candidate capture is expected to end

platform
required
string
Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"

Satellite that will take the capture

constellation
required
string
Value: "GRUS1"
valid_until
required
string <date-time>

Time in the future this candidate will no longer be valid to schedule. Please schedule the candidate before this date.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/geo+json
{}

Task Requests

Request a capture be scheduled. A Task Request has information about the scheduled capture and processed data. Task Requests are limited and your account may be charged.

Task Request Status:

After Tasks reach 'DATA_AVAILABLE' status assets can be fetched from the STAC API.

List Task Requests

List your Tasks

Authorizations:
oauth_token
query Parameters
limit
number <integer> [ 1 .. 20 ]
Default: 10

Result pagination limit

offset
number <integer> >= 1

Result pagination offset

Responses

Response Schema: application/geo+json
type
required
string
Value: "FeatureCollection"
required
Array of objects (Task Request)
Array
type
required
string
Value: "Feature"
id
required
string
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
required
object
name
required
string

Name of the task

created
required
string <date-time>

Time Task Request was created

valid_start
required
string <date-time>

Beginning of the capture window

valid_end
required
string <date-time>

End of the capture window

off_nadir_range
required
Array of numbers <double> = 2 items [ items <double > [ 0 .. 90 ] ]

Range of expected off-nadir angles capture

satellites
required
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"

List of expected satellites used for the capture

priority
required
string
Enum: "NORMAL" "EMERGENCY"

What priority to assign to the Task Request.

cancel_until
null or string <date-time>

Latest date Task Request can be canceled

task_plan_id
null or string

The original Task Plan that this Request is for

status
required
string
Enum: "PLANNED" "PROCESSING" "DATA_AVAILABLE" "REJECTED" "FAILED" "CANCELLED"

Current status of the Task Request

ag:capture_id
null or string

If capture is taken this ID will be the id that uniquely identifies the capture in our system.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer
numberMatched
required
number <integer>

Response samples

Content type
application/geo+json
{}

Create Task request

Create a new Task. To conform to API standards this request is GeoJSON, however when proving a Candidate ID the Polygon geometry should be left empty.

Authorizations:
oauth_token
Request Body schema: application/json
required

Create a new Task

type
required
string
Value: "Feature"
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays

Empty array when providing candidate_id

required
object
name
required
string [ 1 .. 64 ] characters ^(?=.*[ -~])(?!.*[.~|\/${}%\\]).*$
candidate_id
required
string
priority
required
string
Enum: "NORMAL" "EMERGENCY"

Responses

Response Schema: application/geo+json
type
required
string
Value: "Feature"
id
required
string
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
required
object
name
required
string

Name of the task

created
required
string <date-time>

Time Task Request was created

valid_start
required
string <date-time>

Beginning of the capture window

valid_end
required
string <date-time>

End of the capture window

off_nadir_range
required
Array of numbers <double> = 2 items [ items <double > [ 0 .. 90 ] ]

Range of expected off-nadir angles capture

satellites
required
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"

List of expected satellites used for the capture

priority
required
string
Enum: "NORMAL" "EMERGENCY"

What priority to assign to the Task Request.

cancel_until
null or string <date-time>

Latest date Task Request can be canceled

task_plan_id
null or string

The original Task Plan that this Request is for

status
required
string
Enum: "PLANNED" "PROCESSING" "DATA_AVAILABLE" "REJECTED" "FAILED" "CANCELLED"

Current status of the Task Request

ag:capture_id
null or string

If capture is taken this ID will be the id that uniquely identifies the capture in our system.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Request samples

Content type
application/json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/geo+json
{}

Task Request Details

Information about a Request.

Authorizations:
oauth_token
path Parameters
taskRequestId
required
string

unique identifier for a Task Request

Responses

Response Schema: application/geo+json
type
required
string
Value: "Feature"
id
required
string
required
object
type
required
string
Value: "Polygon"
coordinates
required
Array of arrays
required
object
name
required
string

Name of the task

created
required
string <date-time>

Time Task Request was created

valid_start
required
string <date-time>

Beginning of the capture window

valid_end
required
string <date-time>

End of the capture window

off_nadir_range
required
Array of numbers <double> = 2 items [ items <double > [ 0 .. 90 ] ]

Range of expected off-nadir angles capture

satellites
required
Array of strings non-empty
Items Enum: "GRUS-1A" "GRUS-1B" "GRUS-1C" "GRUS-1D" "GRUS-1E"

List of expected satellites used for the capture

priority
required
string
Enum: "NORMAL" "EMERGENCY"

What priority to assign to the Task Request.

cancel_until
null or string <date-time>

Latest date Task Request can be canceled

task_plan_id
null or string

The original Task Plan that this Request is for

status
required
string
Enum: "PLANNED" "PROCESSING" "DATA_AVAILABLE" "REJECTED" "FAILED" "CANCELLED"

Current status of the Task Request

ag:capture_id
null or string

If capture is taken this ID will be the id that uniquely identifies the capture in our system.

required
Array of objects (link)
Array
href
required
string
rel
required
string
type
string
hreflang
string
title
string
length
integer

Response samples

Content type
application/geo+json
{}

Cancel a Task Request

Cancel a Request

Authorizations:
oauth_token
path Parameters
taskRequestId
required
string

unique identifier for a Task Request

Responses

Response samples

Content type
application/json
""