> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shovels.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# About the API Reference

> How the Shovels API Reference is generated, what it covers, and where to report an error.

Every page in the **API Reference** tab is generated directly from the Shovels OpenAPI
specification — the same specification the live API is built against. Endpoints, parameters,
field names, defaults, and response schemas all come from that one source, so the reference
cannot drift out of step with the API itself.

## What this means for you

* **The reference is always current.** When an endpoint gains a parameter or a default changes,
  the documentation updates with it. There is no separate step where someone has to remember to
  write it down.
* **Examples run against the real API.** The interactive playground on each endpoint page calls
  `https://api.shovels.ai/v2` using your own API key.
* **Prose guides are written by hand.** Everything outside the API Reference tab — quickstarts,
  tutorials, the data dictionaries, troubleshooting — is written and maintained by our team.
  Those pages explain *how* and *why*; the API Reference documents *what*.

## Found an error?

If an endpoint page shows a wrong default, a stale field, or a response that doesn't match what
the API actually returns, email [support@shovels.ai](mailto:support@shovels.ai) with the endpoint
and what you observed.

<Info>
  Corrections to the API Reference are made in the OpenAPI specification rather than on the
  documentation site, so these fixes ship with the API. Please include the endpoint path and
  method — it's the fastest way for us to trace the field back to the specification.
</Info>