resource-facade

Choose the minimal set of captures whose clear ground covers the AOI within one temporal epoch. Returns coverage, the true date span, and what is left uncovered. Buys nothing.

post/v1/catalog/clear_coverage/plan

Headers

x-api-keystring nullable

Request body

aoiobject required

GeoJSON Polygon of the area of interest

target_coveragenumber

Stop once this fraction of the AOI is covered by clear ground.

max_span_daysinteger

Hard limit on the date range of a composite. A stack spanning months is not a single-date image; sun angle, shadow length and vegetation all differ. Set 0 to forbid compositing entirely.

max_scenesinteger
target_datestring nullable

ISO date to prefer captures near, e.g. 2026-03-15

date_prioritystring

How hard to pull toward target_date. 'off' ignores it; 'balanced' lets it break ties and order a series without buying a worse capture; 'strict' outweighs even a billing step, for work where the date matters more than the price.

max_off_nadir_degnumber nullable
min_sun_elevation_degnumber nullable
vendorsstring[] nullable

e.g. ["CGSTL"] to order Jilin only

min_marginal_gainnumber

Smallest share of the AOI a capture must add to be worth taking, when taking it does NOT push the order into a higher billing multiplier.

allow_billing_stepboolean

Whether a capture may push the order into a higher billing multiplier at all. False caps the order at its current multiplier.

billing_step_min_gainnumber

How much a capture must add before it is allowed to cross a billing threshold. Guards against buying 2% more ground for twice the price.

Response

Successful Response

coveragenumber required
completeboolean required
is_compositeboolean required
span_daysinteger required
membersobject[] required
uncoveredobject nullable
needs_reviewboolean
review_reasonstring nullable
coverage_rationumber
billed_multiplierinteger
free_budget_remainingnumber
aoi_geometry_invalidboolean
excluded_by_filterobject

Changes

No recorded changes to this endpoint across all 1 revision of this API.