API overview
The Paperoffice API follows REST principles and returns JSON responses. All endpoints are available at https://api.paperoffice.ai.
Authentication
- OAuth 2.0 client credentials flow
- Token lifetime: 60 minutes
- Renew via refresh tokens or another client credentials request
Base URLs
| Environment | Base URL |
|---|---|
| Production | https://api.paperoffice.ai |
| Sandbox | https://api-dev.paperoffice.ai |
Rate limits
| Limit | Description |
|---|---|
| 120 requests/minute | per tenant and access token |
| 3000 requests/hour | per tenant |
When limits are exceeded the API responds with 429 Too Many Requests including Retry-After.
Error handling
All errors follow this schema:
{
"error": "invalid_request",
"message": "Details",
"trace_id": "..."
}
Detailed endpoint descriptions are available in the automatically generated API Reference.