latestOpenAPI 3.1.02026-08-105279262.8 KB

51f7c5a8d15d

legacyPipelines

Create Order

Create a new imagery order. Specify the data source, area of interest, time interval, and processing parameters. The order will be queued for processing and you will receive notifications as it progresses through various stages.

post/pipelines

Request body

namestring

Optional parameter allows you to give your pipeline an identifying name

start_datestring date

Start date of your collection period

end_datestring date

End date of your collection period

budget_per_km2number

Control price by setting the amount you are willing to pay per square kilometre. Use this OR max_cost

max_costnumber

Control price by setting the amount you are willing to pay in total for all results from this pipeline. Use this OR budget

cloud_cover_percentagenumber

Minimum cloud free area your result must have

min_aoi_coverage_percentagenumber

Minimum coverage of your area your result must have

resolution_lownumber
resolution_highnumber
intervalstring
status'active' | 'inactive'
search_idstring uuid

Id of the search that generated the search_results

off_nadir_anglenumber[]

Array containing two numerical values representing the minimum and maximum off-nadir angles, in degrees, within [-90, 90].

Example request

{
  "off_nadir_angle": [
    -30,
    30
  ]
}

Response

Success - pipeline(s) created

Example response

{
  "data": {
    "off_nadir_angle": [
      -30,
      30
    ]
  }
}