Skip to content

List available analysis capabilities

Request

Returns the full catalog of analysis capabilities that can be requested as checks[].type in POST /jobs/make_job. Each entry includes the machine-readable configuration schema (input_schema) accepted in checks[].config, a display label, a token cost hint, and — when the result is stored under a different key than the capability name — the result_key to read from the plot's analysis object.

Use this endpoint to discover new analyses as they are added: the catalog is live, so integrations that read it do not need an API update when a new capability ships. The catalog at the time of writing (the response example below is abbreviated — the live endpoint returns every row of this table):

nameLabel
eudrEUDR
deforestationDeforestation
protected_areaProtected Area
indigenous_landIndigenous Land
visual_verificationVisual Verification
land_coverLand Cover
surface_temperatureSurface Temperature
precipitationPrecipitation
water_detectionWater Detection
fire_damageFire Damage
deforestation_riskDeforestation Risk
forest_loss_by_yearForest Loss By Year
canopy_conditionCanopy Condition
soil_moistureSoil Moisture
productivity_trendProductivity Trend
farm_portfolio_healthFarm Portfolio Health
agricultural_drought_stressAgricultural Drought Stress
agricultural_climate_aridityAgricultural Climate Aridity
enso_teleconnectionEl Niño Climate Sensitivity
enso_seasonal_outlookEl Niño Seasonal Stress
flood_water_historyObserved Flooding
flood_risk_5weeksNear-Term Flood Risk
flood_risk_5yearsLong-Term Flood Risk
wildfire_burn_historyWildfire Burn History
wildfire_risk_5weeksNear-Term Wildfire Risk
wildfire_risk_5yearsLong-Term Wildfire Risk
coastal_erosion_riskCoastal Exposure
solar_site_suitabilitySolar Site Suitability
vineyard_site_suitabilityVineyard Site Suitability
data_center_site_suitabilityData Center Site Suitability
asset_inspection_priorityAsset Inspection Priority
property_due_diligenceProperty Due Diligence
supplier_site_risk_screenSupplier Site Risk
compliance_verification_packCompliance Verification Pack
Security
BearerAuth
Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
GET
/v3/discovery/capabilities
curl -i -X GET \
  https://api.open-atlas.com/_mock/openapi/v3/discovery/capabilities \
  -H 'Authorization: Bearer <YOUR_JWT or vantage_live_ API key_HERE>'

Responses

The list of available capabilities

Bodyapplication/json
Array [
namestring

Capability name. Use this value as checks[].type in POST /jobs/make_job

Example:"soil_moisture"
labelstring

Human-readable display label for the capability

Example:"Soil Moisture"
descriptionstring

What the analysis measures and how to interpret it

input_schemaobject

JSON Schema describing the configuration object accepted in checks[].config for this capability

transportstring

How results are delivered. All capabilities currently complete within the job lifecycle ('sync'); 'async' is reserved for future long-running analyses

Enum:"sync""async"
cost_hintobject(CostHintDTO)

Indicative token cost for running a capability. Use the X-Dry-Run header on POST /jobs/make_job for an exact quote on a concrete set of plots

result_keystring

Key under the plot's analysis object where this capability's result is stored. Only present when it differs from the capability name (e.g. protected_area results are stored under protected_areas)

Example:"protected_areas"
]
Response
Abbreviated example showing one capability of each kind (native bundle, ranger-backed overlap check, per-plot VLM check, and a standard analysis). The live response contains all 33 capabilities listed in the endpoint description
[ { "name": "eudr", "label": "EUDR", "description": "EUDR compliance bundle: deforestation analysis with protected-area and Indigenous-land checks included.", "input_schema": {}, "transport": "sync" }, { "name": "protected_area", "label": "Protected Area", "description": "Checks whether the plot overlaps protected areas and returns overlap, source, and regulatory metadata.", "input_schema": {}, "transport": "sync", "result_key": "protected_areas" }, { "name": "visual_verification", "label": "Visual Verification", "description": "VLM-based verification of an area of interest using recent satellite imagery.", "input_schema": {}, "transport": "sync" }, { "name": "soil_moisture", "label": "Soil Moisture", "description": "Compares recent surface soil moisture with the same place and season in prior years, with rainfall anomaly as supporting context.", "input_schema": {}, "transport": "sync" } ]