List order imagery

get

Returns every image delivered against the order, as a GeoJSON FeatureCollection matching the image API. Each feature carries a links entry with the image download URL. An order whose imagery has not been delivered yet returns an empty collection.

Authorizations

x-api-keystringRequired

API key passed via request header. Either this or the api_key query parameter is required.

Path parameters

spexi_order_idstring · min: 1Required

Spexi-assigned order identifier whose imagery to list.

Example: SPX-20260625-ABC123

Query parameters

limitinteger · min: 1 · max: 1000Optional

Maximum number of images to return. The default is 100.

Default: 100

cursorstring · min: 1Optional

Pagination token for retrieving subsequent result sets. Obtained from the next URL of a previous response.

Responses

200

Images delivered against the order.

application/json

typestring · enumRequiredPossible values:

nextstring · uriOptional

URL to fetch the next page of results, if more exist.

numberReturnednumberRequired

The number of features in the response.

401

Missing or invalid authentication credentials.

403

Caller lacks permission to access tasking orders.

404

No order matches the given spexi_order_id for the caller's organization.

get/developer-api/api/v1/order/{spexi_order_id}/images

GET /developer-api/api/v1/order/{spexi_order_id}/images HTTP/1.1
Host: world.spexi.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "type": "FeatureCollection",
  "features": [
    {
      "id": "text",
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          []
        ]
      },
      "properties": {
        "id": "text",
        "key": "text",
        "url": "https://example.com",
        "captureType": "text",
        "heading": 1,
        "pitch": 1,
        "roll": 1,
        "altitude": 1,
        "tag": "text",
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "capturedAt": "text",
        "processedAt": "text",
        "cameraPosition": {
          "type": "Point",
          "coordinates": null
        },
        "distance": 1,
        "aoiPixelBounds": null,
        "aoiPixelBoundsUnavailable": true
      },
      "links": [
        {
          "rel": "text",
          "href": "https://example.com",
          "type": "text",
          "title": "text"
        }
      ]
    }
  ],
  "next": "https://example.com",
  "numberReturned": 1
}