Skip to main content
Use the files endpoints to inspect individual machine files after Leaf ingests them from a provider or manual upload. This page also covers batch upload endpoints, processing-status inspection, and helper endpoints for uncovered or outside-field data. For conceptual background, see Machine Data Overview and Uploading Files.

Base URL

Endpoints

Machine files

Batch upload

To access machine files, you need a Leaf user with valid provider credentials. See the Users and Integrations documentation to set up credentials.

Get all machine files

GET /files Returns a paginated list of machine files for the authenticated API owner.

Parameters

The default page size is 20 when page and size are not set.

Request


Get a machine file

GET /files/{id} Returns a single machine file by its UUID.

Parameters

Request


Get file summary

GET /files/{id}/summary Returns the summary for a machine file, containing aggregated statistics for the file’s data points.

Parameters

Request


Get file standardGeoParquet

GET /files/{id}/standardGeoparquet Returns a URL to the standard GeoParquet file.
You must enable the enableGeoparquetOutput configuration to use this endpoint.

Parameters

Request


Get file polygonGeoParquet

GET /files/{id}/polygonGeoparquet Returns a URL to the polygon GeoParquet file.
You must enable the enableGeoparquetOutput configuration to use this endpoint.

Parameters

Request


Get file units

GET /files/{id}/units Returns the property-to-unit mapping for the machine file. Properties vary by operation type but use standardized keys across providers.

Parameters

Request


Get file status

GET /files/{id}/status Returns the processing status for each step of Leaf’s pipeline for the specified machine file.

Parameters

Request

Response

Each key represents a pipeline step. The status value is one of:

Common failure messages


Get file outsideFieldGeoJSON

GET /files/{id}/outsideFieldGeojson Returns a GeoJSON file containing data points from the machine file that do not fall within any field boundary.
Requires both splitOperationsByField and enableOutsideFieldGeojson configurations to be enabled.

Parameters

Request

Response


Get all outsideFieldGeoJSON

GET /files/outsideFieldGeojson Returns a list of all machine files that have data points outside field boundaries.
Requires both splitOperationsByField and enableOutsideFieldGeojson configurations to be enabled.

Parameters

Request

Response


Get uncovered files

GET /files/uncoveredFiles Returns a list of machine file IDs that did not generate field operations because they do not intersect with any field boundary.

Parameters

Request

Response


Merge files

POST /files/merge Merges two or more machine files into a single file. Processing is asynchronous — poll the returned file ID to check status. All files must belong to the same Leaf user, share the same operation type, and have processed status.

Request body

Request

Response


Upload a file

POST /batch Uploads a .zip file containing operation data. Leaf detects the files inside the archive, creates machine file entries, and processes them asynchronously.

Parameters

Maximum upload size is 3 GB.
Set provider to Other if you are unsure of the format. Leaf auto-detects files from supported providers.

Request

Response

Batch status values


Get a batch

GET /batch/{id} Returns a single batch upload by its UUID, including the list of generated machine file IDs.

Parameters

Request

Response


Get all batches

GET /batch Returns a paginated list of batch uploads.

Parameters

Request

Response


Retry a batch

PUT /batch/{id}/retry Retries processing for a batch upload. Only reprocesses the files that did not succeed previously — existing converted files are not affected.

Parameters

Request

Response


Get batch files status

GET /batch/{id}/status Returns the processing status of each machine file generated from the batch, grouped by status.

Parameters

Request

Response

Last modified on March 24, 2026