Parchment API docs
Documentation
Parchment API gives you normalized green coffee data from 39+ suppliers through the stable
public catalog endpoint at /v1/catalog, plus supporting docs for the broader internal route layer under /api/* and the
CLI. Start with API docs for HTTP integrations, then use the platform and CLI docs for product
internals and automation workflows.
API docs
Public catalog contract, platform route matrix, billing flows, auth, and operational guidance.
- Overview
Public versus internal surfaces, auth modes, and how the product fits together.
- Catalog
The stable public /v1/catalog contract: fields, limits, compatibility aliases, and headers.
- Platform routes
Authenticated and internal /api/* route matrix for catalog app flows, chat, workspaces, and tools.
- Inventory
Inventory CRUD, share links, stocked-state recalculation, and ownership behavior.
- Roast profiles
Roast CRUD, Artisan import, chart data, clear flows, and AI classification.
- Analytics
The /analytics product surface and the session-auth roast analysis helpers behind it.
- Billing and admin
Stripe lifecycle routes, Console-adjacent flows, webhooks, and admin-only maintenance endpoints.
- Errors and auth
Status codes, auth edge cases, rate limits, and practical troubleshooting notes.
CLI docs
Install, authenticate, and use the Parchment CLI for catalog queries, inventory, roasting, scripting, and agent automation.
- Overview
Install, authenticate, and explore the CLI command structure.
- Auth, config, and output
Viewer versus member auth, local config, output modes, and scripting guarantees.
- Catalog
Search the public catalog from your terminal.
- Inventory
List and manage your green coffee inventory.
- Roast
Create roast records, import Artisan files, and watch folders.
- Sales
Record and update roasted-coffee sales.
- Tasting
Read supplier notes and record personal cupping data.
- Context and manifest
Dense reference text, machine-readable manifest output, and onboarding patterns for agents.
- Agent integration
Use the CLI as a stable interface for AI tools and external agents.
Plans, pricing, quick start, and the public-versus-platform contract split.
Generate API keys, monitor usage, and manage your account.
Browse the green coffee marketplace that the API serves.
Market intelligence: pricing trends, supplier coverage, and origin analysis.