# Delivery API

> Docs for the Delivery API, a mock REST API for managing deliveries, drivers, parcels, and hubs.

- Documentation: https://delivery-api.thally.app
- GitHub: https://github.com/chosenvincent1/delivery-api
- Full docs for LLMs: https://delivery-api.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://delivery-api.thally.app/ai.txt
- Structured docs index (JSON): https://delivery-api.thally.app/api/docs-index
- OpenAPI spec: https://delivery-api.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://delivery-api.thally.app/api/docs/{page-id}
- Search API: https://delivery-api.thally.app/api/search?q={query}
- Capability manifest (skill): https://delivery-api.thally.app/skill.md
- Agent guidance (editing these docs): https://delivery-api.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://delivery-api.thally.app/api/mcp
- Agent readiness: https://delivery-api.thally.app/api/agent-readiness
- Changelog feed (JSON Feed): https://delivery-api.thally.app/changelog/feed.json
- Changelog feed (RSS): https://delivery-api.thally.app/changelog/rss.xml

### Recommended workflow

1. Use this index, the search API, or `search_sections` / `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Get started

### Get started

- [Introduction](https://delivery-api.thally.app/): Learn what the Delivery API does, what to know before you use it, and where to start.
- [Quickstart](https://delivery-api.thally.app/quickstart): Get an access token, list deliveries, and filter the results in three steps.
- [Authentication](https://delivery-api.thally.app/authentication): Get a bearer token, add it to your requests, and fix 401 errors.

## Guides

### Guides

- [Find the right driver for a delivery](https://delivery-api.thally.app/guides/find-the-right-driver): Match a pending delivery with an available driver in the right location.

## API Reference

### API Reference

- [Overview](https://delivery-api.thally.app/api/introduction): What this API reference covers and how to try requests from your browser.

## Changelog

- [Changelog](https://delivery-api.thally.app/changelog): See what's new in the Delivery API documentation.

Interactive API reference available at https://delivery-api.thally.app/api