Skip to main content
The Imagery API gives you access to all satellite and aerial image data associated with your fields. You can browse available imagery from providers like Sentinel-2 and Landsat, filter passes by date range and cloud cover, and upload your own drone orthomosaics for processing. Imagery records form the basis for all vegetation index calculations — every index computation is tied to a specific imagery capture.

The Imagery Object

string
The unique identifier for the imagery record. Prefixed with img_.
string
The ID of the field this image was captured for.
string
The imagery provider. One of sentinel2, landsat, planet, or drone.
string
The date the image was captured, in YYYY-MM-DD format.
number
The percentage of the image obscured by cloud cover, from 0.0 (clear) to 100.0 (fully overcast).
number
The spatial resolution of the image in metres per pixel (e.g., 10 for Sentinel-2).
array
An array of spectral band identifiers available in the image (e.g., ["B02", "B03", "B04", "B08", "B11"]).
string
A URL to a low-resolution preview image. Thumbnails are publicly accessible and do not require authentication.
string
The processing status of the image. One of processing, ready, or failed.

List Imagery for a Field

Retrieve all available imagery records for a given field, optionally filtered by date range, source, and cloud cover. Results are sorted by capture_date descending (most recent first).

Path Parameters

string
required
The unique field ID (e.g., fld_01j8xyz).

Query Parameters

string
Filter to images captured on or after this date. Format: YYYY-MM-DD.
string
Filter to images captured on or before this date. Format: YYYY-MM-DD.
string
Filter by imagery provider. Accepted values: sentinel2, landsat, planet, drone. Omit to return imagery from all sources.
number
default:"20"
Return only images where cloud cover is at or below this percentage (0–100). Set to 100 to include all images regardless of cloud cover.

Example Request

Example Response

Use the max_cloud_cover filter aggressively during cloudy seasons. Images with more than 20% cloud cover often produce unreliable index values, particularly for field-level NDVI analysis.

List Imagery Sources

Retrieve the full list of imagery providers available on the platform, including their resolution, revisit frequency, and subscription requirements.

Example Request

Response Fields

string
The provider identifier used in other endpoints (e.g., sentinel2, planet).
string
The human-readable name of the provider (e.g., "Sentinel-2 (ESA)").
number
The native spatial resolution in metres per pixel.
number
The typical number of days between consecutive passes over the same location.
boolean
If true, access to this source requires a paid add-on or Enterprise plan. Contact your account manager to enable premium sources.

Example Response


Upload Drone Imagery

Upload a drone-captured orthomosaic GeoTIFF for a field. The file is processed asynchronously — the response returns immediately with a status of processing. Subscribe to the imagery.available webhook event to receive a notification when processing is complete.

Path Parameters

string
required
The unique field ID.

Request Body (multipart/form-data)

file
required
The orthomosaic file in GeoTIFF format. Maximum file size is 2 GB. The GeoTIFF must be georeferenced (contain embedded projection and coordinate information).
string
required
The type of imagery in the file. Accepted values:
  • rgb — Standard red, green, blue true-colour image.
  • ndvi — A pre-calculated NDVI single-band raster.
  • multispectral — A multi-band image with separate spectral channels (NIR, Red Edge, etc.).
string
required
The date the drone flight was conducted, in YYYY-MM-DD format.

Example Request

Do not set Content-Type: application/json on upload requests. The Content-Type header is set automatically by your HTTP client when using multipart form data.
Uploading large files over slow connections may time out. For files larger than 500 MB, contact support to request a resumable upload link.