Create document metadata
Create document metadata without file upload. File must be uploaded separately using the file upload endpoint.
AuthorizationBearer <token>
In: header
titlestring
Document title
Length
1 <= lengthdescription?string
Document description
description_markdown?string
Markdown-formatted description
categorystring
Category ID (must be UUID)
Format
uuidaccess_levelstring
Document access level
Value in
"public" | "restricted" | "requires_nda" | "internal"issue_date?string
Issue date in YYYY-MM-DD format
Match
^\d{4}-\d{2}-\d{2}$Format
dateexpiry_date?string
Expiry date in YYYY-MM-DD format
Match
^\d{4}-\d{2}-\d{2}$Format
datevalidity_months?integer
Validity period in months
Range
1 <= valuestate?string
Initial document state
Default
"valid"Value in
"valid" | "pending" | "expired" | "inactive"featured?boolean
Whether document should be featured
Default
falseshow_validity_period_on_card?boolean
Show validity period on card display
Default
truetemplate?string
Template ID to use for document creation
Format
uuidResponse Body
const body = JSON.stringify({
"title": "Privacy Policy",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"access_level": "public"
})
fetch("https://app.orbiqhq.com/api/v1/documents", {
body
}){
"success": true,
"data": {
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"uploadUrl": "/api/v1/documents/doc-123/file"
}
}{
"error": "Invalid input: category: category_must_be_uuid"
}Empty
Empty
How is this guide?