Generate an index PNG for a visualization

Generates an on-the-fly PNG of the index for a given date and mode, with legend overlay. Returns the PNG image as binary data.

POST/v0/aois/{aoi_id}/visualizations/{visualization_id}/png

Authorisations

AuthorizationString

Path Parameters

aoi_idstringrequired

AOI ID

visualization_idstringrequired

Visualization ID

Request Body

index_idstringrequired

UUID of the index to compute the preview forExample: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

datestringrequired

Date string, e.g. 2024_05_06Example: "2024_05_06"

visualization_modestringrequired

Legend mode to use: 'dynamic' or 'theoretical'Example: "dynamic"

Response

image/png

Generate an index PNG for a visualizationcURL
Python
Go
TypeScript
1curl -X POST 'https://api.pixxel.space/v0/aois/{aoi_id}/visualizations/{visualization_id}/png' \
2  -H 'Authorization: YOUR_API_KEY' \
3  -H 'Content-Type: application/json' \
4  -d '{
5  "index_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6  "date": "2024_05_06",
7  "visualization_mode": "dynamic"
8}'

Response:

"string"