Skip to main content
POST
Create canonical Library document metadata

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Headers

Idempotency-Key
string
required

Request key; replay the same key only with the same payload.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

title
string
required

Validation: required|string|min:1|max:255.

Required string length: 1 - 255
document_type
string

Validation: required|string|max:128.

Maximum string length: 128
Pattern: ^[a-z][a-z0-9._:-]*$
owning_domain
string

Validation: required|string|max:128.

Maximum string length: 128
Pattern: ^[a-z][a-z0-9._:-]*$
sensitivity_class
string

Validation: required|string|max:64.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9._:-]*$

Response

Create canonical Library document metadata response.

contract_version
string
outcome
string
command_receipt_id
string
document_id
string | null
idempotency_key_sha256
string
request_sha256
string
recorded_at
string<date-time>
result_sha256
string
document
failure
object | null

Domain rejection code and information, when outcome is conflict.