> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# box

> Files, folders, and collaborations

**Server path:** `/box` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                              | Description                                                                                                                                              |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`box_upload_file`](#box_upload_file)             | Upload a file to Box from a URL.                                                                                                                         |
| [`box_get_file_info`](#box_get_file_info)         | Retrieve file metadata and information about a file using its ID                                                                                         |
| [`box_delete_file`](#box_delete_file)             | Delete a file from Box by its ID                                                                                                                         |
| [`box_create_folder`](#box_create_folder)         | Create a new folder within a specified parent folder                                                                                                     |
| [`box_get_folder_info`](#box_get_folder_info)     | Retrieve information about a folder using its ID                                                                                                         |
| [`box_list_folder_items`](#box_list_folder_items) | List items (files and folders) in a specified folder                                                                                                     |
| [`box_move_folder`](#box_move_folder)             | Move a folder to a different parent folder                                                                                                               |
| [`box_delete_folder`](#box_delete_folder)         | Delete a folder from Box by its ID                                                                                                                       |
| [`box_search`](#box_search)                       | Search for files, folders, and web links across Box content with advanced filtering options. If no query is provided, returns all items from root folder |
| [`box_search_folders`](#box_search_folders)       | Search for folders that contain the specified query in their name. If no query is provided, returns all folders from root folder                         |
| [`box_get_user_info`](#box_get_user_info)         | Get information about the current authenticated user                                                                                                     |

***

## box\_upload\_file

Upload a file to Box from a URL.

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                       |
| ---------- | ------ | -------- | ------- | ------------------------------------------------- |
| `fileUrl`  | string | Yes      | —       | URL of the file to upload to Box                  |
| `parentId` | string | Yes      | —       | ID of the parent folder (use "0" for root folder) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "fileUrl": {
        "type": "string",
        "description": "URL of the file to upload to Box"
      },
      "parentId": {
        "type": "string",
        "description": "ID of the parent folder (use \"0\" for root folder)"
      }
    },
    "required": [
      "PCID",
      "fileUrl",
      "parentId"
    ]
  }
  ```
</Expandable>

***

## box\_get\_file\_info

Retrieve file metadata and information about a file using its ID

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                   |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `fileId`  | string | Yes      | —       | The unique identifier of the file to retrieve information for |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "fileId": {
        "type": "string",
        "description": "The unique identifier of the file to retrieve information for"
      }
    },
    "required": [
      "PCID",
      "fileId"
    ]
  }
  ```
</Expandable>

***

## box\_delete\_file

Delete a file from Box by its ID

**Parameters:**

| Parameter | Type   | Required | Default | Description                                 |
| --------- | ------ | -------- | ------- | ------------------------------------------- |
| `fileId`  | string | Yes      | —       | The unique identifier of the file to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "fileId": {
        "type": "string",
        "description": "The unique identifier of the file to delete"
      }
    },
    "required": [
      "PCID",
      "fileId"
    ]
  }
  ```
</Expandable>

***

## box\_create\_folder

Create a new folder within a specified parent folder

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                       |
| ---------- | ------ | -------- | ------- | ------------------------------------------------- |
| `name`     | string | Yes      | —       | Name of the folder to create                      |
| `parentId` | string | Yes      | —       | ID of the parent folder (use "0" for root folder) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "name": {
        "type": "string",
        "description": "Name of the folder to create"
      },
      "parentId": {
        "type": "string",
        "description": "ID of the parent folder (use \"0\" for root folder)"
      }
    },
    "required": [
      "PCID",
      "name",
      "parentId"
    ]
  }
  ```
</Expandable>

***

## box\_get\_folder\_info

Retrieve information about a folder using its ID

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                                     |
| ---------- | ------ | -------- | ------- | --------------------------------------------------------------- |
| `folderId` | string | Yes      | —       | The unique identifier of the folder to retrieve information for |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "folderId": {
        "type": "string",
        "description": "The unique identifier of the folder to retrieve information for"
      }
    },
    "required": [
      "PCID",
      "folderId"
    ]
  }
  ```
</Expandable>

***

## box\_list\_folder\_items

List items (files and folders) in a specified folder

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                            |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------ |
| `folderId` | string | Yes      | —       | The unique identifier of the folder to list items from |
| `limit`    | number | No       | —       | Maximum number of items to return                      |
| `offset`   | number | No       | —       | Number of items to skip for pagination                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "folderId": {
        "type": "string",
        "description": "The unique identifier of the folder to list items from"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of items to return"
      },
      "offset": {
        "type": "number",
        "description": "Number of items to skip for pagination"
      }
    },
    "required": [
      "PCID",
      "folderId"
    ]
  }
  ```
</Expandable>

***

## box\_move\_folder

Move a folder to a different parent folder

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                 |
| ------------- | ------ | -------- | ------- | ------------------------------------------- |
| `folderId`    | string | Yes      | —       | The unique identifier of the folder to move |
| `newParentId` | string | Yes      | —       | ID of the new parent folder                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "folderId": {
        "type": "string",
        "description": "The unique identifier of the folder to move"
      },
      "newParentId": {
        "type": "string",
        "description": "ID of the new parent folder"
      }
    },
    "required": [
      "PCID",
      "folderId",
      "newParentId"
    ]
  }
  ```
</Expandable>

***

## box\_delete\_folder

Delete a folder from Box by its ID

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                   |
| ----------- | ------- | -------- | ------- | --------------------------------------------- |
| `folderId`  | string  | Yes      | —       | The unique identifier of the folder to delete |
| `recursive` | boolean | No       | `false` | Whether to delete folder contents recursively |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "folderId": {
        "type": "string",
        "description": "The unique identifier of the folder to delete"
      },
      "recursive": {
        "type": "boolean",
        "default": false,
        "description": "Whether to delete folder contents recursively"
      }
    },
    "required": [
      "PCID",
      "folderId"
    ]
  }
  ```
</Expandable>

***

## box\_search

Search for files, folders, and web links across Box content with advanced filtering options. If no query is provided, returns all items from root folder

**Parameters:**

| Parameter                 | Type      | Required | Default | Description                                                           |
| ------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------- |
| `query`                   | string    | No       | —       | Search query string to find items. If not provided, returns all items |
| `type`                    | string    | No       | —       | Filter search results by item type                                    |
| `limit`                   | number    | No       | —       | Maximum number of results to return                                   |
| `offset`                  | number    | No       | —       | Number of results to skip for pagination                              |
| `ancestor_folder_ids`     | string\[] | No       | —       | Limit results to items in specified folders and subfolders            |
| `file_extensions`         | string\[] | No       | —       | Filter by file extension                                              |
| `content_types`           | string\[] | No       | —       | Filter by specific content fields                                     |
| `created_at_range`        | string    | No       | —       | Limit results by creation date range                                  |
| `updated_at_range`        | string    | No       | —       | Limit results by update date range                                    |
| `size_range`              | string    | No       | —       | Filter by file size range                                             |
| `owner_user_ids`          | string\[] | No       | —       | Limit results by owners                                               |
| `recent_updater_user_ids` | string\[] | No       | —       | Filter by users who updated items                                     |
| `trash_content`           | string    | No       | —       | Determine whether to search in trash                                  |
| `mdfilters`               | string    | No       | —       | Filter results based on metadata                                      |
| `sort`                    | string    | No       | —       | Order results by relevance or modification date                       |
| `direction`               | string    | No       | —       | Specify result order direction                                        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "query": {
        "type": "string",
        "description": "Search query string to find items. If not provided, returns all items"
      },
      "type": {
        "type": "string",
        "enum": [
          "file",
          "folder",
          "web_link"
        ],
        "description": "Filter search results by item type"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "offset": {
        "type": "number",
        "description": "Number of results to skip for pagination"
      },
      "ancestor_folder_ids": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Limit results to items in specified folders and subfolders"
      },
      "file_extensions": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Filter by file extension"
      },
      "content_types": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Filter by specific content fields"
      },
      "created_at_range": {
        "type": "string",
        "description": "Limit results by creation date range"
      },
      "updated_at_range": {
        "type": "string",
        "description": "Limit results by update date range"
      },
      "size_range": {
        "type": "string",
        "description": "Filter by file size range"
      },
      "owner_user_ids": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Limit results by owners"
      },
      "recent_updater_user_ids": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Filter by users who updated items"
      },
      "trash_content": {
        "type": "string",
        "description": "Determine whether to search in trash"
      },
      "mdfilters": {
        "type": "string",
        "description": "Filter results based on metadata"
      },
      "sort": {
        "type": "string",
        "description": "Order results by relevance or modification date"
      },
      "direction": {
        "type": "string",
        "enum": [
          "ASC",
          "DESC"
        ],
        "description": "Specify result order direction"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## box\_search\_folders

Search for folders that contain the specified query in their name. If no query is provided, returns all folders from root folder

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------- |
| `query`   | string | No       | —       | Search query to find folders by name. If not provided, returns all folders |
| `limit`   | number | No       | —       | Maximum number of folder results to return                                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      },
      "query": {
        "type": "string",
        "description": "Search query to find folders by name. If not provided, returns all folders"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of folder results to return"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## box\_get\_user\_info

Get information about the current authenticated user

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "The PinkConnect ID for authentication"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>