Skip to content

Create a document

POST
/api/v1/documents
object
title

Default: “Untitled”

string
<= 255 characters
collectionId
required
string format: uuid
parentDocumentId
string format: uuid
text

Markdown body — converted to TipTap JSON internally

string
content

TipTap / ProseMirror JSON document. Use instead of text when you already have structured JSON.

publish

Publish immediately when true

boolean

Created document

object
data
required
object
id
required
string format: uuid
title
required

Document title

string
emoji
required

Optional emoji prefix for the document icon

string | null
text
required

Plain-text content (read-only, derived from body)

string | null
collectionId
required
string | null format: uuid
parentDocumentId
required
string | null format: uuid
teamId
required
string format: uuid
createdById
required
string | null format: uuid
lastModifiedById
required
string | null format: uuid
publishedAt
required

Null = draft

string | null format: date-time
archivedAt
required
string | null format: date-time
deletedAt
required
string | null format: date-time
revision
required
integer
sortOrder
required
number
fullWidth
required
boolean
collaborativeId
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Validation error

object
error
required

Human-readable error message

string

Unauthorized

object
error
required

Human-readable error message

string