Skip to main content
POST
/
v0
/
indices
Create a new index
curl --request POST \
  --url https://api.pixxel.space/v0/indices \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
  "expression_type": "index"
}
'
{
  "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)",
  "expression_type": "index",
  "id": "e9767554-550e-4464-a677-b8cf096073ab",
  "name": "NDVI",
  "rescale": [
    0,
    1
  ],
  "satellite_id": "0002a3a3-00a2-4b55-842b-44d8202c6d60",
  "type": "custom",
  "updated_at": "2022-11-14 12:55:49.125928+00:00"
}

Documentation Index

Fetch the complete documentation index at: https://docs.pixxel.space/llms.txt

Use this file to discover all available pages before exploring further.

📚 View developer guide to learn more

Authorizations

​
Authorization
string
header
required

Body

application/json

Index creation parameters

​
name
string
required
Example:

"NDVI"

​
description
string
required
Example:

"This formula will give insights about vegetation"

​
rescale
integer[]
required
Example:
[0, 1]
​
expression
string
required
Example:

"(B04-B08)/(B04+B08)"

​
colormap
string
required
Example:

"rplumbho"

​
satellite_id
string
required
Example:

"0002a3a3-00a2-4b55-842b-44d8202c6d60"

​
expression_type
enum<string>
required
Available options:
composite,
index,
grayscale
Example:

"index"

Response

Created

​
bands
string[]
Example:
["B01", "B02", "B03"]
​
colormap
string
Example:

"rplumbho"

​
created_at
string
Example:

"2022-11-14 12:55:49.125928+00:00"

​
description
string
Example:

"This formula will give insights about vegetation"

​
expression
string
Example:

"(B04-B08)/(B04+B08)"

​
expression_type
enum<string>
Available options:
composite,
index,
grayscale
Example:

"index"

​
id
string
Example:

"e9767554-550e-4464-a677-b8cf096073ab"

​
name
string
Example:

"NDVI"

​
rescale
integer[]
Example:
[0, 1]
​
satellite_id
string
Example:

"0002a3a3-00a2-4b55-842b-44d8202c6d60"

​
type
enum<string>
Available options:
custom,
preset
Example:

"custom"

​
updated_at
string
Example:

"2022-11-14 12:55:49.125928+00:00"