# SoilSerdem API Documentation

> Programmatic soil-data processing (SME, MZ, YE3, SSE, ODD): upload files, submit jobs, download outputs.

## Getting Started

- [Introduction](https://soilserdem.com/documentation): What the API is and what it can do
- [Overview](https://soilserdem.com/documentation/overview): Overview of the API and how it works
- [Core Concepts](https://soilserdem.com/documentation/getting-started/core-concepts): The files + jobs mental model and processing lifecycle
- [Authentication](https://soilserdem.com/documentation/authentication): API key authentication, rate limits, and security
- [Quick Start](https://soilserdem.com/documentation/quick-start): Run your first yield map (YE3) job in 5 API calls

## API Reference

- [API Reference Overview](https://soilserdem.com/documentation/reference): Base URL, conventions, pagination, and errors
- [API Keys & Usage](https://soilserdem.com/documentation/reference/api-keys): Create, manage, and monitor API keys; the usage endpoint
- [Files](https://soilserdem.com/documentation/reference/files): Upload and manage data files
- [Input Files](https://soilserdem.com/documentation/reference/input-files): Accepted formats for boundary, soil, yield, and management zone files
- [Jobs](https://soilserdem.com/documentation/reference/jobs): Submit and monitor processing jobs
- [Outputs & Units](https://soilserdem.com/documentation/reference/outputs): What the results ZIP contains and how to read units
- [Errors](https://soilserdem.com/documentation/reference/errors): Error envelopes, status codes, and failure reasons

## Workflows

- [Soil Map Engine (SME)](https://soilserdem.com/documentation/guides/sme-workflow): Generate soil property maps
- [Management Zones (MZ)](https://soilserdem.com/documentation/guides/mz-workflow): Create field segmentation zones
- [Yield Editor Three (YE3)](https://soilserdem.com/documentation/guides/ye3-workflow): Interpolate yield data
- [Soil Sampling Engine (SSE)](https://soilserdem.com/documentation/guides/sse-workflow): Generate soil sampling points
- [Machine Data (Automatic Decoding)](https://soilserdem.com/documentation/guides/odd-workflow): Monitor exports decode automatically on upload; no job submission needed

## Resources

- [Why Yield Values Differ](https://soilserdem.com/documentation/guides/why-yields-differ): Why YE3 yield numbers vary across platforms - and how to verify
- [Tools & Examples](https://soilserdem.com/documentation/resources/tools): Quickstart notebooks, Python helper, and the OpenAPI spec
- [Billing & Usage](https://soilserdem.com/documentation/resources/billing): Daily job limits, what counts, and controlling cost
- [Troubleshooting](https://soilserdem.com/documentation/resources/troubleshooting): Common issues by symptom, cause, and fix
- [Glossary](https://soilserdem.com/documentation/resources/glossary): Definitions of API and agricultural terms

## API Reference (OpenAPI)

- [OpenAPI JSON](https://api.soilserdem.com/api/openapi.json)
- [Swagger UI](https://api.soilserdem.com/api/docs)
- [ReDoc](https://api.soilserdem.com/api/redoc)