Create doc

Create a new doc in your Dovetail workspace. Docs are rich-text documents used to write up research reports, share findings, and publish deliverables.

You can provide the initial content as HTML, Markdown, or plain text via the content and content_type fields. Markdown support enables importing content from Confluence, Notion, and other wiki or document stores.

HTML content may include inline Dovetail nodes using the data-dovetail-type attribute — see the mention shape below for an example.

A doc can be placed inside a project (via project_id) or a folder (via folder_id), but not both. If neither is specified, the doc is created at the workspace root level.

Returns the doc object without the content body.

Inline mentions: to reference a Dovetail user, include a span with data-dovetail-type="mn" and data-dovetail-attrs='{"id":"<user-uuid>"}'. The span's inner text is used as the fallback label if the user cannot be resolved. When the id resolves to a live workspace user, the span is replaced with a live mention node on import. Unresolved ids degrade gracefully to plain text — the import does not fail.

Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body

string
length ≤ 200

The doc's title.

fields
array of objects

The doc's fields.

fields
string
length ≤ 100000

The initial content of the doc. Interpreted according to the content_type field (defaults to HTML).

string
enum
Defaults to html

The format of the content field. Defaults to "html". Use "markdown" for Markdown-formatted content (supports headings, lists, bold, italic, code blocks, tables, task lists, links, and blockquotes). Use "text" for plain text.

Allowed:
string | null

Unique identifier of the project that the doc is associated with. Cannot be used together with folder_id.

string | null

Unique identifier of the folder to place the doc in. Cannot be used together with project_id.

string

Unique identifier of the user to set as the author. Only workspace admins can use this field. If omitted, defaults to the authenticated user. Can only be set at creation time. When an admin sets this field, the author change is recorded in workspace audit logs with the API user as the actor, so overrides remain traceable.

string | null

Unique identifier of a file to use as the doc's cover image.

date-time

ISO 8601 datetime to set as the doc's creation date. Only workspace admins can use this field. If omitted, defaults to the current time. Can only be set at creation time.

date-time

ISO 8601 datetime to set as the doc's published date. Only workspace admins can use this field. Requires published: true. If omitted but published: true, defaults to the current time. Can only be set at creation time.

boolean

When true, the doc is published immediately after creation — equivalent to creating a draft and then clicking Publish. Triggers the same notifications and indexing side-effects as the in-app flow. Defaults to false (draft).

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json