RecordEngine exposes a REST API that gives you programmatic access to everything the UI can do — uploading documents, querying extracted data, updating statuses, managing contacts and folders, and triggering AI chat. Combined with the outbound webhook system, the API is the foundation for all RecordEngine integrations.
Base URL
All API endpoints are available at:
https://YOUR-INSTANCE/api/
https://a9f3d7e2.recordengine.ai, the API base URL is:
https://a9f3d7e2.recordengine.ai/api/
Interactive Documentation
RecordEngine includes a full Swagger UI at /api/docs:
https://YOUR-INSTANCE/api/docs
The Swagger UI is the fastest way to explore the API and test calls without writing any code. Use it to find the exact field names and response formats before building your integration.
All API responses are JSON. A successful response returns an HTTP 200 status code with a JSON body. Errors return an appropriate HTTP error code with a detail message:
// Success
{
"id": 847,
"filename": "acme-invoice.pdf",
"status": "Needs Review",
"confidence_score": 87
}
// Error
{
"detail": "Document not found"
}
HTTP Status Codes
| Code | Meaning |
|---|
200 | Success |
201 | Created successfully |
400 | Bad request — check your request body |
401 | Unauthorised — missing or invalid Bearer token |
403 | Forbidden — valid token but insufficient permissions |
404 | Resource not found |
422 | Unprocessable entity — request body failed validation |
500 | Server error — check container logs |
Rate Limits
The RecordEngine API has no enforced rate limits by default for on-premise deployments. Document processing throughput is governed by your hardware — specifically GPU VRAM and processing queue depth — rather than by API rate limiting.
API and Webhooks Together
The API and outbound webhooks are designed to work together:
- Inbound (API): Your systems push documents and data into RecordEngine
- Outbound (Webhooks): RecordEngine pushes processed results out to your systems
A typical integration uses both:
Your system → POST /api/documents/upload → RecordEngine
RecordEngine → Webhook POST to your URL → Your system
Available Endpoint Groups
| Group | What it covers |
|---|
| Documents | Upload, list, retrieve, update status, manage extracted fields |
| Contacts & Folders | Create and list contacts and folders |
| CRM Correlation | Pass and retrieve external_refs for CRM record linking |
| Deep-Links | Generate direct URLs to open specific documents in the UI |
| Webhooks | Outbound webhook configuration and payload schemas |
| Chat API | Ask questions across documents programmatically |
OpenAPI Schema
The full OpenAPI 3.0 schema is available at:
https://YOUR-INSTANCE/api/openapi.json
- Postman: File → Import → Link → paste the URL above
- Insomnia: Application → Import → From URL → paste the URL above
See OpenAPI / Swagger for more details. 
