Skip to main content

Download with the API

Use API downloads for automation and large-scale workflows.

Typical Sequence​

  1. Confirm availability.
  2. Estimate processing unit cost.
  3. Request composite/tile/minitile output.
  4. Store response bytes or use UploadUrl.
  5. Preserve and pass through required source attribution notices when outputs are shared externally.

Choosing an Endpoint Type​

  • POST /api/satelliteimages/process/composite is the default for most download workflows.
  • You can use the composite endpoint even when the original order was tile/minitile-based.
  • POST /api/satelliteimages/process/tile and POST /api/satelliteimages/process/minitile are typically used for very large, grid-based retrieval and finer control near UTM transition zones.
  • Composite downloads use geometry inputs; tile/minitile requests use GUID-based inputs.

Example Flow (Composite)​

  1. Call POST /api/satelliteimages/process/composite/available with your AOI/date/model inputs.
  2. Call POST /api/satelliteimages/process/composite/estimate using the same payload shape.
  3. Validate estimate output (credits, runtime, size) against your workflow budget.
  4. Call POST /api/satelliteimages/process/composite with the approved payload.
  5. Save direct response bytes, or provide UploadUrl for server-side delivery.

Minimal composite request body (Wkt mode):

{
  "Wkt": "POLYGON ((9.877893206725581 56.47856668238974, 10.196496722350581 56.47856668238974, 10.196496722350581 56.27782087776097, 9.877893206725581 56.27782087776097, 9.877893206725581 56.47856668238974))",
  "Date": "2024-05-03T00:00:00Z",
  "Resolution": 10,
  "EpsgProjection": 32632,
  "Model": "Stratus2",
  "SatelliteConstellations": ["Sentinel1", "Sentinel2", "Landsat89"],
  "Bandnames": "all"
}

Use one geometry mode per request: send Wkt or GeoJson, not both.

Main Endpoints​

  • POST /api/satelliteimages/process/composite/available
  • POST /api/satelliteimages/process/composite/estimate
  • POST /api/satelliteimages/process/composite
  • POST /api/satelliteimages/process/tile
  • POST /api/satelliteimages/process/minitile

Implementation Notes​

  • Keep estimate and download payloads aligned to avoid budget mismatches.
  • Handle rate limits and transient failures with retry/backoff (429, 5xx).
  • Prefer UploadUrl for async pipelines that should not hold large binary responses in memory.

For full request/response definitions, see Processing / download endpoints.

For attribution implementation guidance, see Source attribution and external use.