Skip to main content

Integration Recipes

Common implementation patterns for SatSource APIs.

1. Get Crop Health (Sync)

Use this pattern to fetch vegetation indices (NDVI) for a small farm boundary instantly. This is a Synchronous request, meaning the API will wait until the computation is done before returning a response.

Best for: Real-time applications, small polygons (< 100 acres).

Request
POST /v6/intelligence/insight
{
  "insight_intent": "report",
  "reference_id": "CROP_HEALTH_001",
  "insight_scope": [
    {
      "type": "geometry",
      "geometry": { "type": "Polygon", "coordinates": [...] }
    }
  ],
  "insight_protocol": [
    { "report_template_code": 1, "mode": "sync" }
  ]
}

2. Region Discovery

Find the unique region_id for a District within a State. SatSource uses unique UUIDs for all administrative boundaries.

Use the depth: 1 protocol to list immediate children of the scope.

Request
POST /v6/intelligence/insight
{
  "insight_intent": "region_discovery",
  "insight_scope": [
    { "region_id": "STATE_UUID_HERE" }
  ],
  "insight_protocol": [{ "depth": 1 }]
}