Skip to main content

get_doc_folder_list

Get all document folders visible to the current user.
Property
Read-onlyYes

Parameters

None.

Returns

A list of DataDocFolder objects with folder details including ID, name, color, and access restrictions.

get_doc_folder

Get a document folder by its identifier.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDescription
folderIdstringYesThe folder ID. Use get_doc_folder_list.

Returns

A DataDocFolder with folder details.

create_doc_folder

Create a new document folder.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDefaultDescription
namestringYesFolder name.
colorstringNoSlateFolder color.
restrictedTostring[]No[]User group IDs for access restriction. Use get_user_group_list.

Returns

The created DataDocFolder.

update_doc_folder

Update a document folder: name, color, access restrictions, archived status.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
folderIdstringYesThe folder ID. Use get_doc_folder_list.
namestringNoNew folder name.
colorstringNoNew folder color.
restrictedTostring[]NoNew access restriction groups. Use get_user_group_list.
archivedboolNoArchive or unarchive the folder.

Returns

A confirmation message.

delete_doc_folder

Delete a document folder.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
folderIdstringYesThe folder ID. Use get_doc_folder_list.

Returns

No content on success.

get_doc_list

Get all documents in a specific folder, filtered by user permissions.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDescription
folderIdstringYesThe folder ID. Use get_doc_folder_list.

Returns

A list of DataDoc objects with document details including ID, name, folder assignment, context links, and access restrictions.

get_doc

Get a document by its identifier.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDescription
docIdstringYesThe document ID. Use get_doc_list.

Returns

A DataDoc with document details.

create_doc

Create a new document in a folder.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDefaultDescription
folderIdstringYesFolder to create the document in. Use get_doc_folder_list.
namestringYesDocument name.
restrictedTostring[]No[]User group IDs for access restriction.
aiAccessboolNotrueWhether AI agents can access this document.

Returns

The created DataDoc.

update_doc

Update a document: name, context links, access restrictions, archived status.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
docIdstringYesThe document ID. Use get_doc_list.
namestringNoNew document name.
restrictedTostring[]NoNew access restriction groups.
archivedboolNoArchive or unarchive the document.

Returns

A confirmation message.

delete_doc

Delete a document.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
docIdstringYesThe document ID. Use get_doc_list.

Returns

No content on success.

get_doc_content

Get the content body of a document.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDescription
docIdstringYesThe document ID. Use get_doc_list.

Returns

A DataDocContent object with the document’s body content.

update_doc_content

Update the content body of a document.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
docIdstringYesThe document ID. Use get_doc_list.
contentstringYesThe updated document body text (Markdown).

Returns

A confirmation message.