What this handbook is
This knowledge base is the human operating manual of the PaperOffice API: authentication, jobs, start SLA, credits, webhooks and MCP connect URLs.
The endpoint specification is generated live from the API catalog. AI clients should read that file, not copy endpoint lists from articles.
- Compact index:
https://api.paperoffice.ai/latest/docs/llms.txt - Full reference:
https://api.paperoffice.ai/latest/docs/llms-full.txt - Postman collection:
https://api.paperoffice.ai/latest/docs/postman
llms.txt and llms-full.txt are the complete specification for AI clients. Auth, jobs, start SLA, credits, webhooks and MCP belong in these articles.
Base URL
| Environment | Prefix |
|---|---|
| Production | https://api.paperoffice.ai/latest |
| Stage | https://api.paperoffice.ai/stage |
| Development | https://api.paperoffice.ai/dev |
Create tokens in the PaperOffice app under Account → API. Job status lives under Account → API → Job queue.
IDE prompt
Paste this into Cursor, Claude Code or a similar assistant:
Read this API documentation:
https://api.paperoffice.ai/latest/docs/llms-full.txt
Create a Python function that takes an image
and returns OCR text via paperoffice_aiocr___generate.
Omit processing_lane (Fair-Use / workspace default). Use client_wait=true (default) to hold the connection for the result.