Version: 1.0.0

Propper Locker API

Document Storage & Chat API for the Propper Platform.

Base URL

• Production: https://api.propper.ai/v1/locker

Authentication

OAuth 2.0 Bearer token:

Authorization: Bearer <access_token>

OAuth Scopes

Scope	Description
locker:read	Read documents, download files, chat
locker:write	Create documents
locker:admin	Administrative operations (grants read + write)

Key Endpoints

• GET /v1/locker/documents - List documents
• POST /v1/locker/documents - Create document
• GET /v1/locker/documents/:id/download - Download document
• POST /v1/locker/chat - Chat with documents
• POST /v1/locker/chat/stream - Chat with documents (SSE streaming)
• GET /v1/locker/risks - List document risks
• GET /v1/locker/risks/stats - Risk summary statistics
• POST /v1/locker/risks/extract - Extract risks from a document
• GET /v1/locker/settings - Get organization settings
• PATCH /v1/locker/settings - Update organization settings

Rate Limits

Category	Limit
Default	300 req/min
Chat	30 req/min
Downloads	120 req/min

---

Request correlation

Every response (success and error) includes an x-request-id header (a UUID) and a traceparent header (W3C Trace Context). Error bodies also carry the same id as requestId. Quote x-request-id when contacting support to pinpoint the exact request, and use it to correlate the API with your own logs. Send your own traceparent to tie a multi-call workflow under one trace.

Authentication

HTTP: Bearer Auth

OAuth 2.0 access token

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT