Data Request

The current release available from the Amini Data Platform is released on .

https://api.prd.amini.ai/public/api/v1/polygons

Introduction

This endpoint allows you request for datapoints to be processed given your own locations of interest, along with a specified start and end date, which will be used to query the Data Catalog to then serve you the datapoints via a JSON payload.

Request Headers

x-api-key · string

A unique identifier used to authenticate the API request. This key is provided to developers upon registration and should be kept confidential.

data · string

The path to a file (CSV is the only file type supported at the moment) that contains the geopolygons, and start date and end date of query.

indexes · string

A list of paramters (e.g., spatial index like NDVI) that you want to request. Check the full list of supported datapoints for reference.

Request

    curl -X 'POST' \
    'https://api.prd.amini.ai/public/api/v1/polygons' \
    -H 'accept: application/json' \
    -H 'x-api-key: INSERT API KEY' \
    -H 'Content-Type: multipart/form-data' \
    -F 'data=@INSERT CSV FILE HERE;type=text/csv' \
    -F 'indexes=ndvi,evi,ccci'

Response

message · string

This contains the status message of your job. If successful, it will return ‘Job created successfully’.

cost · float

The cost of the submitted job in USD ($).

results-status · string

The status of the job submitted.

results-id · string

A unique identifier for the job, which can be used to request datapoints by Job ID.

Response

    {
        "message": "Job created successfully",
        "cost": 1.165674603174603,
        "result": {
            "status": "success",
            "id": "{JOB ID}"
        }
    }