Documentation Powered by ReDoc

Clipper API (0.1)

Download OpenAPI specification:Download

API Support: support@kisanhub.com

The clipper project is responsible for the clipping of geospatial imagery from larger tiles of imagery. Where tiles overlap, merging of subsequent clips may be necessary.

clip

Clip images

Clip a list of geotiff files given a geometry. Output a multiband geotiff.

Request Body schema: application/json
geojson
object (Polygon)

A geojson polygon

src
Array of strings (ImageList)

URIs of images to interact with

dst
string (DestinationKey)

key to save the file to

dst_bucket
string (DestinationBucket)

bucket to save the file to

Responses

200

OK

204

No content, where the resulting image is fully masked

post /clip

Clipper server

https://clipper-wp4a3kxs2q-ew.a.run.app/clip

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "geojson":
    {
    },
  • "src":
    [
    ],
  • "dst": "string",
  • "dst_bucket": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dst": "example_file_key.tif"
}

health-check

Health check to ensure service is running

Health check to ensure service is running

Responses

200

OK

get /health-check

Clipper server

https://clipper-wp4a3kxs2q-ew.a.run.app/health-check

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "online"
}

merge

Merge images

Merge a list of geotiff files. Images must be in the same CRS.

Request Body schema: application/json
src
required
Array of strings (ImageList)

URIs of images to interact with

dst
required
string (DestinationKey)

key to save the file to

dst_bucket
required
string (DestinationBucket)

bucket to save the file to

delete_src
boolean (DeleteSource)

Delete the source files if true

Responses

200

OK

post /merge

Clipper server

https://clipper-wp4a3kxs2q-ew.a.run.app/merge

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "src":
    [
    ],
  • "dst": "string",
  • "dst_bucket": "string",
  • "delete_src": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dst": "example_file_key.tif"
}