Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Diro REST API reference
https://www.getdiro.com/api/v1
Authorization: Bearer diro_your_api_key
{
"success": true,
"data": { ... },
"meta": {
"timestamp": "2025-01-22T10:30:00.000Z"
}
}
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Human-readable message"
},
"meta": {
"timestamp": "2025-01-22T10:30:00.000Z"
}
}
| Code | Description |
|---|---|
INVALID_API_KEY | API key is missing or invalid |
API_ACCESS_DENIED | Plan doesn’t include API access |
VALIDATION_ERROR | Request body validation failed |
MISSING_FIELD | Required field is missing |
TEMPLATE_NOT_FOUND | Template doesn’t exist |
DOCUMENT_NOT_FOUND | Document doesn’t exist |
RENDER_LIMIT_EXCEEDED | Monthly render limit reached |
RENDER_FAILED | Document generation failed |
| Plan | Monthly Renders |
|---|---|
| Free | 50 |
| Starter | 150 |
| Pro | 500 |
| Enterprise | 5,000 |
{
"success": false,
"error": {
"code": "RENDER_LIMIT_EXCEEDED",
"message": "Monthly render limit exceeded. Current: 500/500"
}
}
| Method | Endpoint | Description |
|---|---|---|
POST | /documents | Generate a document |
GET | /documents | List documents |
GET | /documents/{id} | Get document details |
GET | /documents/{id}/download | Download document file |
DELETE | /documents/{id} | Delete a document |
| Method | Endpoint | Description |
|---|---|---|
GET | /templates | List templates |
GET | /templates/{id} | Get template details |
GET /api/v1/documents?limit=20&offset=0
| Parameter | Default | Max |
|---|---|---|
limit | 20 | 100 |
offset | 0 | - |