> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/egnyte.md).

# Egnyte

Egnyte file system and AI. Connect with API key and user credentials.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector       | Authentication |
| --------------- | -------------- |
| Egnyte (API)    | Credentials    |
| Egnyte (OAuth2) | OAuth sign-in  |

#### Egnyte (API)

Connect to Egnyte with your domain, API key, API secret, and user credentials. Uses Resource Owner flow; tokens are stored and refreshed automatically.

**Set up in Egnyte**

1. Register for API access on the Egnyte Developer Portal at <https://developers.egnyte.com/member/register> to obtain an **API key** (client ID) and **API secret** for your Egnyte domain.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Egnyte (API)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field              | Required | What to enter                                                                                                |
| -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| API Secret (Client Secret) | Yes      | The secret key paired with your API key.                                                                     |
| Egnyte Domain              | Yes      | Your Egnyte subdomain (e.g. acme) or full domain (e.g. acme.egnyte.com, or acme.egnytegov.com for GovCloud). |
| API Key (Client ID)        | Yes      | The API key provided when you registered your application.                                                   |
| Username                   | Yes      | Egnyte username for the Resource Owner flow.                                                                 |
| Password                   | Yes      | Egnyte password.                                                                                             |

**Provider documentation:** [Setup reference](https://developers.egnyte.com/docs/read/Public_API_Authentication).

#### Egnyte (OAuth2)

Connect to Egnyte using OAuth2 authorization code flow. An admin sets the Egnyte domain once; users just click Connect.

**Set up in Egnyte**

1. Sign in to Egnyte and authorize the requested permissions.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Egnyte (OAuth2)**.
2. Complete the connector configuration below. If you do not have access to these settings, ask your StackAI administrator to configure the connector.
3. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
4. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connector configuration**

| StackAI field | Required  | What to enter                                                                                                                                                                                                |
| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| OAuth Scopes  | Read-only | OAuth scopes for Egnyte API access. This value is shown for reference; it is not an editable credential.                                                                                                     |
| Redirect URI  | Read-only | Use this redirect URI when configuring your OAuth application. This value is shown for reference; it is not an editable credential.                                                                          |
| Egnyte Domain | Yes       | Your Egnyte subdomain (e.g. acme) or full domain (e.g. acme.egnyte.com, or acme.egnytegov.com for GovCloud). [Provider instructions](https://developers.egnyte.com/api-docs/read/public-api-authentication). |

**Provider documentation:** [Setup reference](https://developers.egnyte.com/docs/read/Public_API_Authentication).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

#### Detailed setup guides

* [Connect Egnyte](https://docs.stackai.com/integrations/catalog/egnyte/connect-egnyte.md)

## Use an action

1. Add the required **Egnyte** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Hybrid Search

Search Egnyte combining keyword and semantic search

**Inputs**

| Field                 | Type    | Required | Description                                                                            |
| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------- |
| Query                 | string  | Yes      | Search query (3-250 characters). Combines keyword and semantic search.                 |
| Required Folder Paths | string  | No       | Only return results from these folders (comma/semicolon/newline separated). Default: . |
| Exclude Folder Paths  | string  | No       | Exclude results from these folders (comma/semicolon/newline separated). Default: .     |
| Semantic Weight       | number  | No       | Balance between keyword (0.0) and semantic (1.0) search. Default 0.3. Default: 0.3.    |
| Limit                 | integer | No       | Maximum number of results (1-50). Default 5. Minimum: 1. Maximum: 50. Default: 5.      |

**Outputs**

| Field   | Type          | Description     |
| ------- | ------------- | --------------- |
| Results | object\_array | Search results. |

#### Summarize Document

Generate an AI-driven summary of an Egnyte document.

**Inputs**

| Field  | Type            | Required | Description                                                                  |
| ------ | --------------- | -------- | ---------------------------------------------------------------------------- |
| Folder | string          | Yes      | The folder path containing the document. Default: /.                         |
| File   | select (string) | Yes      | Select the document to summarize. Options load from the selected connection. |

**Outputs**

| Field   | Type   | Description                               |
| ------- | ------ | ----------------------------------------- |
| Summary | string | The AI-generated summary of the document. |

#### Ask Document Question

Ask a question about an Egnyte document using AI.

**Inputs**

| Field             | Type            | Required | Description                                                                            |
| ----------------- | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Folder            | string          | Yes      | The folder path containing the document. Default: /.                                   |
| File              | select (string) | Yes      | Select the document to ask questions about. Options load from the selected connection. |
| Question          | string          | Yes      | The question to ask about the document (3-250 characters).                             |
| Include Citations | boolean         | No       | Whether to include source citations in the response. Default: false.                   |

**Outputs**

| Field  | Type   | Description                              |
| ------ | ------ | ---------------------------------------- |
| Answer | string | The AI-generated answer to the question. |

#### Upload File

Upload a file to Egnyte. Creates new file or updates existing.

**Inputs**

| Field          | Type     | Required | Description                                                         |
| -------------- | -------- | -------- | ------------------------------------------------------------------- |
| File Path      | string   | Yes      | Full path where the file will be created/updated in Egnyte.         |
| Source URL     | string   | No       | URL of a file to download and upload to Egnyte.                     |
| Base64 Content | string   | No       | Base64 encoded file content (from file nodes or binary data).       |
| Text Content   | textarea | No       | Raw text content to upload as a file (UTF-8 encoded).               |
| Content Type   | string   | No       | MIME type of the file. Auto-detected from filename if not provided. |

**Outputs**

| Field     | Type   | Description                                            |
| --------- | ------ | ------------------------------------------------------ |
| Group ID  | string | Permanent identifier for the file across all versions. |
| Entry ID  | string | Identifier for this specific version of the file.      |
| Checksum  | string | SHA512 checksum of the uploaded file.                  |
| File Path | string | Full path of the uploaded file.                        |

#### Download File

Download a file from Egnyte.

**Inputs**

| Field              | Type            | Required | Description                                                             |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------- |
| Folder             | string          | Yes      | The folder path containing the file. Default: /.                        |
| File               | select (string) | Yes      | Select the file to download. Options load from the selected connection. |
| Entry ID (Version) | string          | No       | Optional entry ID to download a specific version of the file.           |

**Outputs**

| Field        | Type   | Description                                             |
| ------------ | ------ | ------------------------------------------------------- |
| Download URL | string | Temporary URL to download the file (expires in 1 hour). |

#### List Files

List files and folders in an Egnyte directory.

**Inputs**

| Field               | Type            | Required | Description                                                                          |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Folder Path         | string          | Yes      | Path to the folder to list.                                                          |
| Count               | integer         | No       | Maximum number of items to return (1-1000). Minimum: 1. Maximum: 1000. Default: 100. |
| Offset              | integer         | No       | Starting index for pagination (0-based). Minimum: 0. Default: 0.                     |
| Sort By             | select (string) | No       | Field to sort results by. Available values: Name, Last Modified, Uploaded By.        |
| Sort Direction      | select (string) | No       | Sort direction (ascending or descending). Available values: Ascending, Descending.   |
| Include Permissions | boolean         | No       | Include user's permission level in the response. Default: false.                     |

**Outputs**

| Field       | Type          | Description                          |
| ----------- | ------------- | ------------------------------------ |
| Folder Name | string        | Name of the listed folder.           |
| Folder Path | string        | Full path of the listed folder.      |
| Total Count | integer       | Total number of items in the folder. |
| Folders     | object\_array | List of subfolders.                  |
| Files       | object\_array | List of files.                       |

#### Create Folder

Create a folder in Egnyte.

**Inputs**

| Field              | Type   | Required | Description                                                                      |
| ------------------ | ------ | -------- | -------------------------------------------------------------------------------- |
| Parent Folder Path | string | Yes      | Full path of the parent folder where the new folder will be created. Default: /. |
| Folder Name        | string | Yes      | Name of the folder to create.                                                    |

**Outputs**

| Field       | Type   | Description                              |
| ----------- | ------ | ---------------------------------------- |
| Folder ID   | string | Unique identifier of the created folder. |
| Folder Path | string | Full path of the created folder.         |

#### Move File or Folder

Move a file or folder to a new path in Egnyte.

**Inputs**

| Field               | Type            | Required | Description                                                                                                                                                                      |
| ------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Source Path         | string          | Yes      | Full path of the file or folder to move.                                                                                                                                         |
| Destination Path    | string          | Yes      | Full absolute path after the move (new location and name).                                                                                                                       |
| Permissions         | select (string) | No       | How permissions are applied when moving a folder. If omitted, Egnyte uses the domain default. Available values: Keep original permissions, Inherit from parent.                  |
| Folder Options Mode | select (string) | No       | How folder options are handled when moving a folder. If omitted, Egnyte uses the domain default. Available values: Keep source folder options, Apply destination folder options. |

**Outputs**

| Field     | Type   | Description                                                        |
| --------- | ------ | ------------------------------------------------------------------ |
| Path      | string | Full path of the item after the move.                              |
| Folder ID | string | Folder ID when a folder was moved (empty for files).               |
| Group ID  | string | Permanent file group ID when a file was moved (empty for folders). |

#### Copy File or Folder

Copy a file or folder to a new path in Egnyte.

**Inputs**

| Field               | Type            | Required | Description                                                                                                                                                                       |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Source Path         | string          | Yes      | Full path of the file or folder to copy.                                                                                                                                          |
| Destination Path    | string          | Yes      | Full absolute path for the copy (new location and name).                                                                                                                          |
| Permissions         | select (string) | No       | How permissions are applied when copying a folder. If omitted, Egnyte uses the domain default. Available values: Keep original permissions, Inherit from parent.                  |
| Folder Options Mode | select (string) | No       | How folder options are handled when copying a folder. If omitted, Egnyte uses the domain default. Available values: Keep source folder options, Apply destination folder options. |

**Outputs**

| Field     | Type   | Description                                                         |
| --------- | ------ | ------------------------------------------------------------------- |
| Path      | string | Full path of the copied item.                                       |
| Folder ID | string | Folder ID when a folder was copied (empty for files).               |
| Group ID  | string | Permanent file group ID when a file was copied (empty for folders). |

#### Delete File or Folder

Delete a file or folder in Egnyte.

**Inputs**

| Field               | Type   | Required | Description                                          |
| ------------------- | ------ | -------- | ---------------------------------------------------- |
| Path                | string | Yes      | Full path of the file or folder to delete.           |
| Entry ID (optional) | string | No       | Optional entry ID to delete a specific file version. |

**Outputs**

| Field              | Type   | Description                                                     |
| ------------------ | ------ | --------------------------------------------------------------- |
| Parent Folder Path | string | Path to the parent folder of the deleted item (per Egnyte API). |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/egnyte.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
