API v1 ReferenceDocuments

Creates a new document with optional HTML or Markdown content.

When content is provided, set `contentFormat` to `html` or `markdown`. HTML is the default. Canonical awork Markdown preserves safe editor structures during re-import. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a multipart form containing an optional file.
namestring or nullOptional0-1000 characters
The name of the document.
documentSpaceIdstring or nullOptionalformat: "uuid"
The id of the document space.
parentIdstring or nullOptionalformat: "uuid"
The id of the document's parent document.
projectIdstring or nullOptionalformat: "uuid"
The id of the project this document references.
taskIdstring or nullOptionalformat: "uuid"
The id of the task this document references.
emojistring or nullOptional0-25 characters
The emoji of the document.
isPrivatebooleanOptional
Whether the document is private.
orderdouble or nullOptional
The order of the document in either the list of private docs, the referenced document space or in the referenced project.
workspaceAccessLevelenum or nullOptional

Determines the level of access to this document granted to all workspace users. Can be either null (inherited), none, read, or manage.

Allowed values:
isHiddenForConnectUsersboolean or nullOptional
Whether the document is hidden for connect users.
contentfileOptional

The optional UTF-8 document content. Use Awork.Core.Models.Documents.Documents.DocumentPostForm.ContentFormat to select HTML or Markdown input.

contentFormatenum or nullOptional

The input format of Awork.Core.Models.Documents.Documents.DocumentPostForm.Content. Defaults to html. Canonical awork Markdown supports lossless re-import of safe editor content.

Allowed values:

Response

OK
idstringOptionalformat: "uuid"
The id of the entity.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.
namestring or nullOptional
The name of the document.
currentDocumentVersionIdstring or nullOptionalformat: "uuid"
The id of the current document version.
documentSpaceIdstring or nullOptionalformat: "uuid"
The id of the document space.
documentSpaceobjectOptional
parentIdstring or nullOptionalformat: "uuid"
The id of the document's parent document.
projectIdstring or nullOptionalformat: "uuid"
The id of the project this document references.
projectobjectOptional
taskIdstring or nullOptionalformat: "uuid"
The id of the task this document references.
emojistring or nullOptional
The emoji of the document.
isPrivatebooleanOptional
Whether the document is private.
orderdouble or nullOptional
The order of the document in either the list of private docs, the referenced document space or in the referenced project.
isExternalbooleanOptional
Whether the document belongs to an external project.
isHiddenForConnectUsersbooleanOptional
Whether the document is hidden for connect users.
contributorslist of objects or nullOptional
The contributors of this document.
teamslist of objects or nullOptional
The teams this document is connected to.
workspaceAccessLevelstring or nullOptional

Determines the level of access to this document granted to all workspace users. Can be either not set (no access), read, or manage.

inheritedWorkspaceAccessFromDocumentIdstring or nullOptionalformat: "uuid"
The id of the document the workspace access level permission has been inherited from.
inheritedWorkspaceAccessFromDocumentobjectOptional
movedToTrashOnstring or nullOptionalformat: "date-time"
The date the document has been moved to the trash
movedToTrashBystring or nullOptionalformat: "uuid"
The id of the user that moved the document to the trash.
rootDocumentCreatedBystringOptionalformat: "uuid"
The user id of the creator of the root document of this document's document tree.