Skip to main content
POST
Create Plot

Autorisierungen

Authorization
string
header
erforderlich

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Body

application/json

Fields read from the request body. Anything else — including server-owned fields such as id, analysisStatus, analysisResult, deforestationRiskResult, forestPercentage, isDegraded, imageWidth, imageHeight, pixelCoords, createdAt and updatedAt — is ignored.

name
string

Plot name. Part of the duplicate check (case and surrounding/multiple whitespace are ignored).

country
string

Country of production, ISO 3166-1 alpha-2 (e.g. BR). Part of the duplicate check.

geojson
object

Plot geometry as GeoJSON: a Feature or a bare Geometry (Polygon, MultiPolygon, Point, …) in WGS84 longitude/latitude. Coordinates outside longitude ±180 / latitude ±90 are rejected with 400, as is a geometry above the intake limits. A point is only accepted up to 4 ha (20,000 ha for cattle) when size is given; above that EUDR requires a polygon. Part of the duplicate check.

size
number

Area in hectares. Must be a finite number ≥ 0, otherwise 400.

Erforderlicher Bereich: x >= 0
commodityGroup
enum<string>

EUDR-regulated commodity groups. non_relevant = article is not covered by EUDR.

Verfügbare Optionen:
cattle,
cocoa,
coffee,
oil_palm,
rubber,
soya,
wood,
non_relevant
species
object[]

Tree species. Each entry needs both a common and a scientific name, otherwise 400. Required (at least one scientific name) when commodityGroup is wood.

Maximum array length: 500
scientificName
string

Legacy single-species shorthand, used only when species is empty. Prefer species.

producerName
string

Name of the producer.

productionDateFrom
string<date>

Start of the production period (YYYY-MM-DD).

productionDateTo
string<date>

End of the production period (YYYY-MM-DD).

supplierArticleIds
string<uuid>[]

Supplier articles to link the plot to on creation (optional; duplicates are collapsed). Every id must belong to your company, otherwise 403. Part of the duplicate check: the same plot with a different set of links is a new plot. If commodityGroup is missing or non_relevant, it is derived from the linked articles.

Maximum array length: 5000

Antwort

Plot created, or an identical plot already existed (see deduplicated)

created
object

A single plot as returned to an API key. The full analysis payload (analysisResult) and the image-space fields (pixelCoords, imageWidth, imageHeight) are not part of the API response.

deduplicated
boolean

false: a new plot was created and its analysis queued. true: an identical plot already existed; created is the stored plot and no second plot or analysis run was created.

updated
boolean

Only when deduplicated is true: whether non-empty producerName, productionDateFrom, productionDateTo or species from the request were applied to the stored plot.