Skip to main content

Tasking / Order Endpoints

Use this page as the endpoint map for order operations: tile search, estimate, create, status tracking, and cancellation. This page is intentionally compact. For end-to-end workflow guidance, see Create an order with the API.

Before You Start​

Required headers:

x-api-key: <your-api-key>
Content-Type: application/json

Minimal Request Example​

Typical first call pair for order creation:

curl -X POST "https://api.clearsky.vision/api/tasking/orders/estimate" \
  -H "x-api-key: $CLEARSKY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Wkt": "POLYGON((9.87 56.47,10.19 56.47,10.19 56.28,9.87 56.28,9.87 56.47))",
    "SatelliteConstellations": ["Sentinel1", "Sentinel2", "Landsat89"],
    "Model": "Stratus2",
    "StorageMonths": 1,
    "ApiRequests": 1,
    "ImageFrequency": 3,
    "ReferenceDate": "2025-01-01",
    "From": "2025-04-01",
    "To": null
  }'

Then submit the validated payload to POST /api/tasking/orders.

When setting Model, use API enum values (for example Stratus2), not display labels (for example Stratus-2).

Endpoint index:

  • POST /api/tasking/search/tiles
  • GET /api/tasking/orders
  • GET /api/tasking/orders/details
  • POST /api/tasking/orders/estimate
  • POST /api/tasking/orders
  • DELETE /api/tasking/orders/cancel
  • GET /api/tasking/models

Tile/mini-tile deduplication is configured on the create endpoint:

  • POST https://api.clearsky.vision/api/tasking/orders
  • TileDeduplication (boolean): set true to deduplicate tile/mini-tile orders against all previous tile/mini-tile orders.

Common Failure and Fix​

  • Failure: 400 from mixed AOI inputs (for example sending both Wkt and GeoJson).
  • Fix: choose one AOI mode and revalidate payload structure before retry.
  • Failure: tile deduplication does not suppress previously ordered coverage as expected.
  • Fix: for tile/mini-tile orders, keep deduplication-relevant settings aligned with prior orders (Model, SatelliteConstellations, tile selection, and time/cadence settings). See Create an order with the API.

For reliability, apply this baseline:

  • Retry 429 and 5xx with exponential backoff and jitter.
  • Do not blindly retry 400; fix the request payload first.
  • For 401/403, verify key validity, scope, and account context.

Next Step​