Create Insights on an AOI

Creates an insight or get the estimated cost of running the insight.

POST/v0/aoi/{aoi_id}/insights

Authorisations

AuthorizationString

Path Parameters

aoi_idstringrequired

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

Request Body

namestring

Name is a human-readable title for the insight

blockobjectrequired

Describes the processing block to use for the insight

Show child attributes

inputinteger[]required

Inputs to the insight

project_idstring

Identifies which project this insight belongs to

metadataobject

Contains additional key-value information about the insight

estimateboolean

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

Response

application/json

When estimating cost

estimateinteger

Estimate provides the computed cost value for the insight execution

Create Insights on an AOIcURL
Python
Go
TypeScript
1curl -X POST 'https://api.pixxel.space/v0/aoi/{aoi_id}/insights' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"block": {
  "name": "string",
  "string": "string",
  "version": "string"
},
"input": [
  0
],
"project_id": "string",
"metadata": {},
"estimate": true
17}'

Response:

{
  "estimate": 0
}