← Back to all apps

Overview

Tools Available23
CategoryCollaboration

Explore and analyze your content

Available Tools

Egnyte provides 23 tools that can be used to interact with its services.

Advanced Search

advanced_search
Full Description

Search files and folders at Egnyte using advanced search parameters.

Parameters

Required
querystring

Search text (min 3 characters, max 100 characters)

Optional
countinteger

Results count (1-20). Maximum value is 20, it is not possible to fetch more results at once.

custom_metadataarray

Metadata filters with namespace, key, operator, value. Provide this argument in JSON format.

file_query_fieldsarray

['ALL'/'FILENAME'/'COMMENTS'/'CONTENT']. Provide this argument in JSON format.

folderstring

Folder path like '/Shared/Documents'

folder_query_fieldsarray

['ALL'/'FOLDERNAME'/'DESCRIPTION']. Provide this argument in JSON format.

mltarray

Document IDs for similarity search. Provide this argument in JSON format.

mlttarray

Text content for similarity search. Provide this argument in JSON format.

modified_afterinteger

Unix timestamp in milliseconds

modified_beforeinteger

Unix timestamp in milliseconds

namespacesarray

Namespaces to include in results. Provide this argument in JSON format.

offsetinteger

Start position (0-based)

query_operatorstring

'ALL'/'ANY' word matching

Options:ANYALL
snippet_requestedboolean

Include text snippets

sort_bystring

'score'/'last_modified'/'size'/'name'

Options:last_modifiedsizenamescore
sort_directionstring

'ascending'/'descending'

Options:ascendingdescending
typestring

'FILE'/'FOLDER'/'ALL'

Options:FILEFOLDERALL
uploaded_afterinteger

Unix timestamp in milliseconds

uploaded_beforeinteger

Unix timestamp in milliseconds

Ask Copilot

ask_copilot
Full Description

Ask a question to Egnyte Copilot with optional context from specific files/folders.

Parameters

Required
questionstring

The question to ask Copilot

Optional
chat_historyarray

Previous conversation messages as list of {"role": "user/assistant", "content": "message"}. Provide this argument in JSON format.

file_entry_idsarray

List of file entry IDs (UUID format) to include in context. Can be obtained from listing Egnyte filesystem. Provide this argument in JSON format.

folder_idsarray

List of folder IDs (UUID format) to include in context. Can be obtained from listing Egnyte filesystem. Provide this argument in JSON format.

include_citationsboolean

Whether to include citations in the response (defaults to false)

Ask Document

ask_document
Full Description

Ask a question about a specific document in Egnyte using Egnyte AI.

Parameters

Required
entry_idstring

The unique identifier (UUID format) of the document version. Can be obtained from listing Egnyte filesystem.

questionstring

The specific question user wants to ask against the document

Optional
chat_historyarray

Previous conversation messages as list of {"role": "user/assistant", "content": "message"}. Provide this argument in JSON format.

include_citationsboolean

Whether to include citations in the response (defaults to false)

Ask Knowledge Base

ask_knowledge_base
Full Description

Ask a question to a specific Knowledge Base.

Parameters

Required
kb_idstring

The unique identifier of the Knowledge Base

questionstring

The question to ask the Knowledge Base

Optional
chat_historyarray

Previous conversation messages as list of {"role": "user/assistant", "content": "message"}. Provide this argument in JSON format.

include_citationsboolean

Whether to include citations in the response

Download File By Id

download_file_by_id
Full Description

Download a file from Egnyte file system by unique file ID.

Parameters

Required
idstring

Unique file identifier (UUID format, group_id from file listings or search results). Can be obtained from listing Egnyte filesystem.

Optional
entry_idstring

Specific version entry ID (UUID format) to download (downloads current version if omitted). Can be obtained from listing Egnyte filesystem.

Download File By Path

download_file_by_path
Full Description

Download a file from Egnyte file system by path.

Parameters

Required
pathstring

Full path to the file (e.g., "/Shared/Documents/report.pdf")

Optional
entry_idstring

Specific version entry ID (UUID format) to download (downloads current version if omitted). Can be obtained from listing Egnyte filesystem.

Fetch

fetch
Full Description

Fetch content of a specific document in Egnyte.

Parameters

Required
idstring

The unique identifier of the document to fetch in format group_id/entry_id (both UUIDs). Can be obtained from 'search' tool results

Get Comment

get_comment
Full Description

Get detailed information for a specific comment in Egnyte by its unique identifier.

Parameters

Required
comment_idstring

The unique UUID identifier of the comment to retrieve

Get Folder Stats

get_folder_stats
Full Description

Get comprehensive statistics for a folder in Egnyte including size and item counts.

Parameters

Required
folder_idstring

Unique identifier of the folder

Get Link Details

get_link_details
Full Description

Get detailed information about a specific Egnyte link by its ID.

Parameters

Required
link_idstring

The unique identifier of the link to retrieve

Get Project Details

get_project_details
Full Description

Get detailed information about a specific project by its unique ID.

Parameters

Required
project_idstring

The unique identifier of the project to retrieve

Get Workflow Details

get_workflow_details
Full Description

Get detailed information for a specific workflow by its unique identifier. Retrieves comprehensive workflow details including all steps, tasks, comments and status information.

Parameters

Required
workflow_idstring

The unique UUID identifier of the workflow to retrieve

List Comments

list_comments
Full Description

List comments for a specific file/folder or all comments in the Egnyte domain.

Parameters

Required
file_pathstring

URL encoded path to the file to get comments for (if not provided, returns all domain comments), do not provide folders

Optional
countinteger

Number of results to return (default: 25, max: 100)

end_timestring

Get comments created before this time in ISO 8601 format (e.g., "2024-12-31T23:59:59Z")

offsetinteger

Zero-based index for pagination (default: 0)

start_timestring

Get comments created after this time in ISO 8601 format (e.g., "2024-01-01T00:00:00Z")

List Filesystem By Id

list_filesystem_by_id
Full Description

List files and folders in Egnyte file system by unique ID with comprehensive metadata and options.

Parameters

Required
idstring

Unique identifier (UUID format) of the file (group_id) or folder (folder_id). Can be obtained from listing Egnyte filesystem.

typestring

Resource type - 'file' or 'folder'

Optional
allowed_link_typesboolean

Include allowed link types for files and folders

countinteger

Maximum number of items to return for pagination

include_collaborationboolean

Include collaboration app/integration info (requires include_locks=true)

include_locksboolean

Include file lock information

include_permboolean

Include current user's permission level on folders/files

keystring

Custom metadata field to sort by (format: namespace.key) - required when sort_by='custom_metadata'

list_contentboolean

Include folder contents (files and subfolders) - default: true

list_custom_metadataboolean

Include custom metadata for each item

offsetinteger

Zero-based index for pagination start position

permsboolean

Include detailed permissions for users and groups

sort_bystring

Sort field - 'name', 'last_modified', 'uploaded_by', 'custom_metadata'

Options:namelast_modifieduploaded_bycustom_metadata
sort_directionstring

Sort direction - 'ascending' or 'descending'

Options:ascendingdescending

List Filesystem By Path

list_filesystem_by_path
Full Description

List files and folders in Egnyte file system by path with comprehensive metadata and options.

Parameters

Required
pathstring

Full path to file or folder (e.g., "/Shared/Documents", "/Private/user/folder")

Optional
allowed_link_typesboolean

Include allowed link types for files and folders

countinteger

Maximum number of items to return for pagination

include_collaborationboolean

Include collaboration app/integration info (requires include_locks=true)

include_locksboolean

Include file lock information

include_permboolean

Include current user's permission level on folders/files

keystring

Custom metadata field to sort by (format: namespace.key) - required when sort_by='custom_metadata'

list_contentboolean

Include folder contents (files and subfolders) - default: true

list_custom_metadataboolean

Include custom metadata for each item

offsetinteger

Zero-based index for pagination start position

permsboolean

Include detailed permissions for users and groups

sort_bystring

Sort field - 'name', 'last_modified', 'uploaded_by', 'custom_metadata'

Options:namelast_modifieduploaded_bycustom_metadata
sort_directionstring

Sort direction - 'ascending' or 'descending'

Options:ascendingdescending

List Knowledge Bases

list_knowledge_bases
Full Description

List available Knowledge Bases in Egnyte.

Parameters

Required
sort_byarray

Sort criteria - ["name"] or ["createdOn"]. Count of elements in sort_by and sort_direction must be the same. Provide this argument in JSON format.

sort_directionarray

Sort direction - ["ASC"] or ["DESC"]. Count of elements in sort_by and sort_direction must be the same. Provide this argument in JSON format.

statusarray

Filter by status - ["ACTIVE"], ["DELETED"], ["CREATED"]. Provide this argument in JSON format.

Optional
created_afterinteger

Filter by creation date (milliseconds since epoch)

created_beforeinteger

Filter by creation date (milliseconds since epoch)

created_byinteger

Filter by creator user ID

include_placeholder_databoolean

Include placeholder data in response

include_processing_statisticsboolean

Include processing statistics

include_promptsboolean

Include prompt data

pageinteger

Page number for pagination (0-based)

sizeinteger

Number of results per page

List Links

list_links
Full Description

List Egnyte links with filtering and pagination support.

Parameters

Optional
accessibilitystring

Filter by accessibility - 'anyone', 'password', 'domain', 'recipients'

Options:anyonepassworddomainrecipients
countinteger

Number of results to return (max 500)

created_afterstring

date in format YYYY-MM-DD - links created after this date

created_beforestring

date in format YYYY-MM-DD - links created before this date

offsetinteger

Starting position for pagination (0-based)

pathstring

Filter links to specific file or folder path

typestring

Filter by link type - 'file' or 'folder'

Options:filefolder
usernamestring

Filter links created by specific user

List Projects

list_projects
Full Description

List all project folders in the Egnyte domain.

List Workflow Tasks

list_workflow_tasks
Full Description

List workflow tasks assigned to the current user with filtering and pagination support.

Parameters

Optional
limitinteger

Maximum tasks to return per call (1-50, default: 50)

offsetinteger

Zero-based pagination offset (default: 0)

sortBystring

Sort field - 'NAME', 'DUE_DATE', 'STATUS', 'TASK_TYPE' (default: 'DUE_DATE')

Options:NAMEDUE_DATESTATUSTASK_TYPE
sortDirectionstring

Sort direction - 'ASC', 'DESC' (default: 'ASC')

Options:ASCDESC
statusstring

Filter tasks by status - 'IN_PROGRESS', 'BEING_CANCELLED', 'CANCELLED', 'SUSPENDED', 'APPROVED', 'REJECTED', 'COMPLETED'

Options:IN_PROGRESSCANCELLEDAPPROVEDREJECTEDCOMPLETED

List Workflows

list_workflows
Full Description

List Egnyte workflows with comprehensive filtering and pagination support.

Parameters

Optional
assigneeIdinteger

Filter workflows assigned to specific user ID

assignerIdinteger

Filter workflows created by specific user ID

completionStatusstring

Filter completed workflows by approval status - 'APPROVED', 'REJECTED'

Options:APPROVEDREJECTED
groupIdstring

Filter workflows created on specific file (UUID format, group_id). Can be obtained from listing Egnyte filesystem.

limitinteger

Maximum workflows to return per call (1-25, default: 25)

offsetinteger

Zero-based pagination offset (default: 0)

sortBystring

Sort field - 'NAME', 'CREATION_DATE', 'DUE_DATE', 'COMPLETION_DATE', 'WORKFLOW_STATUS', 'WORKFLOW_COMPLETION_STATUS' (default: 'DUE_DATE')

Options:NAMECREATION_DATEDUE_DATECOMPLETION_DATEWORKFLOW_STATUSWORKFLOW_COMPLETION_STATUS
sortDirectionstring

Sort direction - 'ASC', 'DESC' (default: 'ASC')

Options:ASCDESC
statusstring

Filter by workflow status - 'IN_PROGRESS', 'BEING_CANCELLED', 'CANCELLED', 'SUSPENDED', 'COMPLETED'

Options:IN_PROGRESSBEING_CANCELLEDCANCELLEDSUSPENDEDCOMPLETED

Search

search
Full Description

Search for files in Egnyte by full text query. It returns a list of documents with content snippets.The index used for search is made from file name, its extracted content and metadata.

Parameters

Required
querystring

The search query string to find relevant documents

Search Projects By Folder

search_projects_by_folder
Full Description

Search for projects by root folder ID.

Parameters

Required
root_folder_idstring

The unique identifier of the root folder to search for

Summarize Document

summarize_document
Full Description

Generate a summary of a specific document in Egnyte using Egnyte AI.

Parameters

Required
entry_idstring

The unique identifier (UUID format) of the document version. Can be obtained from listing Egnyte filesystem.

Optional
chat_historyarray

Previous conversation messages as list of {"role": "user/assistant", "content": "message"}. Provide this argument in JSON format.