Skip to main content
POST
Create Document Record

Request

Binary uploads are handled out-of-band through a signed URL flow. This endpoint records the metadata for a document whose bytes have already been uploaded to the workspace’s object store at storage_path. To obtain a signed upload URL, use POST /v1/documents/upload-url (documented separately under Storage).

Headers

string
Optional UUID for retry deduplication within 24 hours.

Body Parameters

string
required
Display name of the document. 1 - 255 characters.
string
required
IANA media type of the file (e.g. application/pdf, image/png).
string
required
Object storage key where the uploaded bytes live. Usually returned by the signed-upload flow.
integer
Size of the uploaded file, in bytes. Used for quota tracking.
string
Optional description.
string
Optional folder path. Created on demand. Example: /clients/acme/ndas.
array
Optional array of tag strings.

Response

object
The created document record (same shape as GET /v1/documents/{id}).
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.

Example Response

Errors