Asynchronous Processing API Reference

• Async API
  • Async Process
    • postSubmit a new async process request
    • getGet status of the request

API docs by Redocly

API Reference (1.0.0)

Download OpenAPI specification:Download

Async Process

NOTE: Asynchronous Processing API is currently in beta release.

Submit a new async process request

Authorizations:

OAuth2

Request Body schema: application/json

required	object (ProcessRequestInput)
required	object (AsyncProcessRequestOutput)
evalscript	string Your evalscript. For details, click here. Either this or evalscriptReference parameter is required.
	S3BucketInfo (object) or GSBucketInfo (object) (ObjectStorageInfoV2)

Responses

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

Request samples

• Payload

Content type

application/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"

        }

      }

    ],
  • "delivery": {

    • "s3": {

      • "url": "string",
      • "iamRoleARN": "string",
      • "accessKey": "string",
      • "secretAccessKey": "string",
      • "region": "string"

      }

    }

  },
• "evalscript": "string",
• "evalscriptReference": {

  • "s3": {

    • "url": "string",
    • "iamRoleARN": "string",
    • "accessKey": "string",
    • "secretAccessKey": "string",
    • "region": "string"

    }

  }

}

Response samples

• 200
• 400

Content type

application/json

{

• "id": "string",
• "status": "RUNNING"

}

Get status of the request

The status of the request will only be returned while it's running. After completion (either succeed or failure) this endpoint will return 404.

Authorizations:

OAuth2

path Parameters

requestId required

string <uuid> Request ID

Responses

https://services.sentinel-hub.com/api/v1/async/process/{requestId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "status": "RUNNING"

}