Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Indices

Create a new index

Creates a new custom index with the provided parameters. This endpoint is for creating custom indices only; preset indices are pre-generated and can be viewed using the list indices endpoint.

post/v0/indices

Request body

namestring required
descriptionstring required
rescaleinteger[] required
expressionstring required
colormapstring required
satellite_idstring required
expression_type'composite' | 'index' | 'grayscale' required

Example request

{
  "name": "NDVI",
  "description": "This formula will give insights about vegetation",
  "rescale": [
    0,
    1
  ],
  "expression": "(B04-B08)/(B04+B08)",
  "colormap": "rplumbho",
  "satellite_id": "0002a3a3-00a2-4b55-842b-44d8202c6d60"
}

Response

Created

bandsstring[]
colormapstring
created_atstring
descriptionstring
expressionstring
expression_type'composite' | 'index' | 'grayscale'
idstring
namestring
rescaleinteger[]
satellite_idstring
type'custom' | 'preset'
updated_atstring

Example response

{
  "bands": [
    "B01",
    "B02",
    "B03"
  ],
  "colormap": "rplumbho",
  "created_at": "2022-11-14 12:55:49.125928+00:00",
  "description": "This formula will give insights about vegetation",
  "expression": "(B04-B08)/(B04+B08)",
  "id": "e9767554-550e-4464-a677-b8cf096073ab",
  "name": "NDVI",
  "rescale": [
    0,
    1
  ],
  "satellite_id": "0002a3a3-00a2-4b55-842b-44d8202c6d60",
  "updated_at": "2022-11-14 12:55:49.125928+00:00"
}