Locker API Overview
The Locker API enables you to store, manage, and chat with documents programmatically. Upload files, organize with metadata and tags, and use AI-powered chat to query document contents.
Key Features
- Document Storage - Upload, organize, and retrieve documents with metadata and tags
- AI Chat - Ask questions about your documents using natural language
- Streaming Responses - Real-time AI chat responses via Server-Sent Events (SSE)
- Full-Text Search - Search across document contents and metadata
- Flexible Upload - Upload via base64-encoded JSON or multipart form data (up to 50 MB)
Architecture
Core Concepts
Document
A document is a file stored in Propper Locker with associated metadata. Documents can be uploaded, organized with tags, and queried via AI chat.
Chat Session
A chat session lets you ask questions about one or more documents. The AI engine uses document contents to generate answers with source references. Sessions can maintain conversation history for follow-up questions.
Document Types
| Type | Description |
|---|---|
CONTRACT | Legal contracts and agreements |
INVOICE | Invoices and billing documents |
REPORT | Reports and analyses |
POLICY | Policies and compliance documents |
OTHER | General documents (default) |
API Base URL
| Environment | Base URL |
|---|---|
| Production | https://api.propper.ai/v1/locker |
Authentication
The Locker API uses OAuth 2.0 with bearer tokens:
POST https://auth.propper.ai/oauth2/token
Content-Type: application/json
{
"grant_type": "client_credentials",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"scope": "locker:read locker:write"
}
OAuth Scopes
| Scope | Description |
|---|---|
locker:read | Read documents, download files, chat with documents |
locker:write | Create and update documents, upload files |
locker:admin | Administrative operations including purge (grants read + write) |
Rate Limits
| Category | Limit |
|---|---|
| Default | 300 req/min |
| Chat | 30 req/min |
| Downloads | 120 req/min |
See the Rate Limits page for details on limits, headers, and best practices.
Next Steps
Quickstart
Upload a document and chat with it in 5 minutes.
API Reference
Complete endpoint documentation with examples.