Batch API¶

Batch Processing API (or shortly "Batch API") enables you to request data for large areas and/or longer time periods. The Batch functionalities mimic the Core functionalities. However, for statistical comparison of a supply base (i.e. user-provided plots) to a reference area (supply region, administrative unit, watersheds), the Batch API must be used, as it produces plot-level sustainability metrics, as well as regional-level metrics.

Available Endpoints¶

The Batch API provides the following endpoints for large-scale processing:

Plot Management¶

/stage_plots - Upload and stage plot geometries for batch processing
/upload_plots - Process staged plots and prepare them for analysis

Data Processing¶

/batch_process - Execute comprehensive sustainability analysis on uploaded plots
/batch_zonal_stats - Generate statistical comparisons between plots and reference areas
/batch_supply_shed - Create supply shed analysis for traceability and risk assessment

Advanced Configuration¶

Input Payload Documentation - Detailed guide to the complex input_payload parameter structure

Data Management¶

/update_practices_data - Update agricultural practices data for non-biomass emissions calculations
/non_biomass_inputs - Compute non-biomass emissions inputs from agricultural practices

Notifications¶

/webhook_notifications - Configure webhooks for real-time processing status updates

Key Features¶

Asynchronous Processing¶

It is an asynchronous REST service. This means that data will not be returned immediately in a request response but will be delivered to your user dashboard. The generated data is stored in a structured database for now, and ultimately will be anonymized and pushed on blockchain for immutability and perennity.

Comprehensive Analysis¶

The Batch API provides: - Plot-level sustainability metrics - Regional-level statistical comparisons - Supply shed analysis and traceability - Agricultural practices emissions calculations - Real-time processing status updates

Data Access Options¶

If the user wants to consult the data outside of the dashboard, he/she can either: - Download the generated data in GeoJSON or CSV from the dashboard (current solution) - Use the Fetch API to retrieve processed data programmatically - Query the data directly using standard SQL language (TBC)

Workflow¶

Automated Processing Flow¶

The batch workflow is:

Authentication - Obtain access token
Register Webhook - Set up status notifications (optional)
Batch Process - Execute sustainability analysis
Batch Supply Shed - Execute supply shed analysis (optional)
Batch Progress - Monitor processing progress
Fetch APIs - Retrieve processed data
Export EUDR DDS - Generate compliance documentation (optional)

Integration with Other APIs¶

Core API Integration¶

The Batch API leverages the same underlying analysis as the Core API but scales it for large datasets.

Fetch API Integration¶

Processed batch data can be retrieved using the Fetch API for programmatic access and integration.

EUDR Compliance¶

The Batch API supports EUDR compliance workflows through integrated risk assessment and documentation generation.