Documents

Register an upload

POST
/documents

Register a document's metadata before its bytes are uploaded. Returns the document_id needed by documents.upload_url and documents.upload_confirm.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128
Idempotency-Key*string

A unique key for this intended write. Reuse it only for an identical retry.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/documents" \  -H "Idempotency-Key: 123e4567-e89b-42d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{    "space_id": "123e4567-e89b-42d3-a456-426614174000",    "file_name": "invoice-2026-09.pdf",    "file_size": 0  }'
{  "document_id": "123e4567-e89b-42d3-a456-426614174000",  "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf",  "status": "ACTIVE",  "space_id": "123e4567-e89b-42d3-a456-426614174000",  "folder_id": "123e4567-e89b-42d3-a456-426614174000"}