Processing API Reference

• Process API
  • Process
    • postProcess

API docs by Redocly

API Reference (1.0.0)

Download OpenAPI specification:Download

This page contains the documentation on how to use sentinel hub services through API calls.

Note: This documentation is not complete

Process

Make sure to use the appropriate end-point for each of the datasets, e.g. for Landsat, Sentinel-3, etc.

Process

Authorizations:

OAuth2

header Parameters

Accept

string Sets response type and has priority over the type defined in the output object of the request. Possible values are image/jpeg, image/png, image/tiff, application/json, application/tar, application/x-tar, multipart/mixed, and application/octet-stream.

Request Body schema:

application/jsonmultipart/form-dataapplication/json

required	object (ProcessRequestInput)
	object (ProcessRequestOutput)
evalscript required	string Your evalscript. For details, click here.

Responses

https://services.sentinel-hub.com/api/v1/process

Request samples

• Payload
• Javascript
• Python
• Curl
• Curl (multipart)

Content type

application/jsonmultipart/form-dataapplication/json

{

• "input": {

  • "bounds": {

    • "bbox": {

      • "0": 13.822174072265625,
      • "1": 45.85080395917834,
      • "2": 14.55963134765625,
      • "3": 46.29191774991382

      },
    • "geometry": {

      • "type": "Polygon",
      • "coordinates": {

        • "0": {

          • "0": {

            • "0": 14.000701904296873,
            • "1": 46.23685258143992

            },
          • "1": {

            • "0": 13.822174072265625,
            • "1": 46.09037664604301

            },
          • "2": {

            • "0": 14.113311767578125,
            • "1": 45.85080395917834

            },
          • "3": {

            • "0": 14.55963134765625,
            • "1": 46.038922598236

            },
          • "4": {

            • "0": 14.441528320312498,
            • "1": 46.28717293114449

            },
          • "5": {

            • "0": 14.17236328125,
            • "1": 46.29191774991382

            },
          • "6": {

            • "0": 14.000701904296873,
            • "1": 46.23685258143992

            }

          }

        }

      },
    • "properties": {

      • "crs": "http://www.opengis.net/def/crs/OGC/1.3/CRS84"

      }

    },
  • "data": [

    • {

      • "type": "sentinel-2-l1c",
      • "id": "string",
      • "dataFilter": {

        • "timeRange": {

          • "from": "2018-10-01T00:00:00.000Z",
          • "to": "2018-11-01T00:00:00.000Z"

          },
        • "mosaickingOrder": "mostRecent",
        • "maxCloudCoverage": 100,
        • "previewMode": "DETAIL"

        },
      • "processing": {

        • "upsampling": "NEAREST",
        • "downsampling": "NEAREST",
        • "harmonizeValues": true

        }

      }

    ]

  },
• "output": {

  • "width": 512,
  • "height": 512,
  • "resx": 0.1,
  • "resy": 0.1,
  • "responses": [

    • {

      • "identifier": "<identifier>",
      • "format": {

        • "type": "image/png"

        }

      }

    ]

  },
• "evalscript": "string"

}

Response samples

• 200
• 400
• 500

Content type

image/jpegimage/pngimage/tiffapplication/jsonmultipart/mixedapplication/x-tarimage/jpeg

No sample