Skip to main content
POST
/
v0
/
aoi
/
{aoi_id}
/
insights
Create Insights on an AOI
curl --request POST \
  --url https://api.pixxel.space/v0/aoi/{aoi_id}/insights \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "block": {
    "name": "<string>",
    "string": "<string>",
    "version": "<string>"
  },
  "input": [
    123
  ],
  "project_id": "<string>",
  "metadata": {},
  "estimate": true
}'
{
  "estimate": 123
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
aoi_id
string
required

ID of the AOI on which you want to run the insight

Body

application/json

Create Insight request body

​
block
object
required

Describes the processing block to use for the insight

​
input
integer[]
required

Inputs to the insight

​
name
string

Name is a human-readable title for the insight

​
project_id
string

Identifies which project this insight belongs to

​
metadata
object

Contains additional key-value information about the insight

​
estimate
boolean

Indicates whether to return a cost estimate instead of running the insight.

Response

When estimating cost

​
estimate
integer

Estimate provides the computed cost value for the insight execution

⌘I