Skip to main content
POST
Upload a private document version
Use a valid workspace bearer session. An API key cannot authorize this endpoint. The current workspace and environment are derived from that session. See information handling for file limits, versioning, holds, retention and disposal behavior.

Authorizations

Authorization
string
header
required

JWT for user-initiated operations

Headers

Idempotency-Key
string<uuid>
required

One UUID per intended upload. Reuse it with the same file for retries; do not reuse it for different files.

Body

multipart/form-data
file
file
required

PDF or UTF-8 .txt, .md, .json, .yaml, .yml file, 1 byte to 5 MiB.

document_id
string<uuid>

Omit for a new document. Supply an active document ID to append a new version.

title
string

Required for a new document.

Maximum string length: 160
category
enum<string>

Required for a new document.

Available options:
technical_specification,
architecture,
security,
policy,
general
description
string
Maximum string length: 2000

Response

Successful response

id
string<uuid>
document_id
string<uuid>
version
integer
filename
string
content_type
string
size_bytes
integer
sha256
string
Pattern: ^[a-f0-9]{64}$
created_at
string<date-time>
purged_at
string<date-time> | null