Skip to main content
Authorize a document upload

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Body

application/json
file_name
string
required
Required string length: 1 - 255
mime_type
string
required
Maximum string length: 255
Pattern: ^[a-z0-9!#$&^_.+-]+\/[a-z0-9!#$&^_.+-]+$
file_size
integer
required
Required range: 100 <= x <= 52428800
category
enum<string>
Available options:
invoice,
agreement,
other

Response

Document ID and scoped upload URL, required headers, and expiration.

document_id
string<uuid>
required
upload_url
string<uri>
required
headers
object
required
expires_at
string<date-time>
required