Create document metadata

Create document metadata without file upload. File must be uploaded separately using the file upload endpoint.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Document title

Length1 <= length

slug?string

Optional URL-friendly slug for public links

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

description?string

Document description

description_markdown?string

Markdown-formatted description

source?string

Optional document source/provider

Value in"google_docs" | "sharepoint" | "notion"

source_id?string

Provider-specific ID for the document

category*string

Category ID (must be UUID)

Formatuuid

access_level*string

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}$

Formatdate

expiry_date?string

Expiry date in YYYY-MM-DD format

Match^\d{4}-\d{2}-\d{2}$

Formatdate

validity_months?integer

Validity period in months

Range1 <= value

status?string

Initial document status

Default"published"

Value in"draft" | "published" | "archived"

featured?

Featured placement flags for controls/resources sections

show_validity_period_on_card?boolean

Show validity period on card display

Defaulttrue

template?string

Template ID to use for document creation

Formatuuid

Response Body

`application/json`

curl -X POST "https://app.orbiqhq.com/api/v1/documents" \  -H "Content-Type: application/json" \  -d '{    "title": "Privacy Policy",    "description": "Company privacy policy document",    "category": "550e8400-e29b-41d4-a716-446655440000",    "access_level": "public"  }'

{
  "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

{
  "error": "slug_already_exists"
}

Empty

How is this guide?

Authorization

Request Body

Response Body

201application/json

400application/json

401

409application/json

500

`application/json`

`application/json`

`application/json`