> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.airweave.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.airweave.ai/_mcp/server.
# Box
> Box integration with Airweave
{/* AUTO-GENERATED CONTENT START */}
Box
This connector enables AI agents and RAG systems to retrieve context from Box through Airweave's unified search layer.
## Configuration
Box source connector integrates with the Box API to extract and synchronize data.
Connects to your Box account and syncs folders, files, comments, users, and collaborations.
#### [View Source Code](https://github.com/airweave-ai/airweave/tree/main/backend/airweave/platform/sources/box.py)
Explore the Box connector implementation
### Authentication
This connector uses **OAuth 2.0 authentication**. You can connect through the Airweave UI or API using the OAuth flow.
**Supported authentication methods:**
* OAuth Browser Flow (recommended for UI)
* OAuth Token (for programmatic access)
* Auth Provider (enterprise SSO)
### Configuration Options
This connector does not have any additional configuration options.
## Data Models
The following data models are available for this connector:
#### BoxUserEntity
Schema for Box user entities.
| Field | Type | Description |
| ----------------- | ------------------- | -------------------------------------------------- |
| user\_id | str | Box user ID |
| name | str | Display name of the user |
| created\_at | Optional\[datetime] | When the user was created |
| updated\_at | Optional\[datetime] | When the user was last modified |
| login | Optional\[str] | Login email address of the user |
| status | Optional\[str] | Status of the user (active, inactive, etc.) |
| job\_title | Optional\[str] | Job title of the user |
| phone | Optional\[str] | Phone number of the user |
| address | Optional\[str] | Address of the user |
| language | Optional\[str] | Language of the user |
| timezone | Optional\[str] | Timezone of the user |
| space\_amount | Optional\[int] | Total storage space available to the user in bytes |
| space\_used | Optional\[int] | Storage space used by the user in bytes |
| max\_upload\_size | Optional\[int] | Maximum file size the user can upload in bytes |
| avatar\_url | Optional\[str] | URL to the user's avatar image |
#### BoxFolderEntity
Schema for Box folder entities.
| Field | Type | Description |
| --------------------- | ------------------- | ------------------------------------------------------------- |
| folder\_id | str | Box folder ID |
| name | str | Folder name |
| created\_at | Optional\[datetime] | When the folder was created |
| updated\_at | Optional\[datetime] | When the folder was last modified |
| description | Optional\[str] | Description of the folder |
| size | Optional\[int] | Size of the folder in bytes |
| path\_collection | List\[Dict] | Path of parent folders from root to this folder |
| content\_created\_at | Optional\[Any] | When the content in this folder was originally created |
| content\_modified\_at | Optional\[Any] | When the content in this folder was last modified |
| created\_by | Optional\[Dict] | User who created this folder |
| modified\_by | Optional\[Dict] | User who last modified this folder |
| owned\_by | Optional\[Dict] | User who owns this folder |
| parent\_id | Optional\[str] | ID of the parent folder |
| parent\_name | Optional\[str] | Name of the parent folder |
| item\_status | Optional\[str] | Status of the folder (active, trashed, deleted) |
| shared\_link | Optional\[Dict] | Shared link information for this folder |
| folder\_upload\_email | Optional\[Dict] | Email address that can be used to upload files to this folder |
| tags | List\[str] | Tags associated with this folder |
| has\_collaborations | Optional\[bool] | Whether this folder has collaborations |
| permissions | Optional\[Dict] | Permissions the current user has on this folder |
| permalink\_url | Optional\[str] | Direct link to view the folder in Box |
| etag | Optional\[str] | Entity tag for versioning |
| sequence\_id | Optional\[str] | Sequence ID for the most recent user event |
#### BoxFileEntity
Schema for Box file entities.
| Field | Type | Description |
| --------------------- | ------------------- | ---------------------------------------------------- |
| file\_id | str | Box file ID |
| name | str | File name |
| created\_at | Optional\[datetime] | When the file was created |
| updated\_at | Optional\[datetime] | When the file was last modified |
| description | Optional\[str] | Description of the file |
| parent\_folder\_id | str | ID of the parent folder |
| parent\_folder\_name | str | Name of the parent folder |
| path\_collection | List\[Dict] | Path of parent folders from root to this file |
| sha1 | Optional\[str] | SHA1 hash of the file contents |
| extension | Optional\[str] | File extension |
| version\_number | Optional\[str] | Version number of the file |
| comment\_count | Optional\[int] | Number of comments on this file |
| content\_created\_at | Optional\[Any] | When the content of this file was originally created |
| content\_modified\_at | Optional\[Any] | When the content of this file was last modified |
| created\_by | Optional\[Dict] | User who created this file |
| modified\_by | Optional\[Dict] | User who last modified this file |
| owned\_by | Optional\[Dict] | User who owns this file |
| item\_status | Optional\[str] | Status of the file (active, trashed, deleted) |
| shared\_link | Optional\[Dict] | Shared link information for this file |
| tags | List\[str] | Tags associated with this file |
| has\_collaborations | Optional\[bool] | Whether this file has collaborations |
| permissions | Optional\[Dict] | Permissions the current user has on this file |
| lock | Optional\[Dict] | Lock information if the file is locked |
| permalink\_url | Optional\[str] | Direct link to view the file in Box |
| etag | Optional\[str] | Entity tag for versioning |
| sequence\_id | Optional\[str] | Sequence ID for the most recent user event |
#### BoxCommentEntity
Schema for Box comment entities.
| Field | Type | Description |
| ------------------ | ------------------- | -------------------------------------------------- |
| comment\_id | str | Box comment ID |
| name | str | Comment preview or identifier |
| created\_at | Optional\[datetime] | When the comment was created |
| updated\_at | Optional\[datetime] | When the comment was last modified |
| file\_id | str | ID of the file this comment is on |
| file\_name | str | Name of the file |
| message | str | Content of the comment |
| created\_by | Dict | User who created this comment |
| is\_reply\_comment | bool | Whether this comment is a reply to another comment |
| tagged\_message | Optional\[str] | Tagged version of the message with user mentions |
#### BoxCollaborationEntity
Schema for Box collaboration entities.
| Field | Type | Description |
| ----------------- | ------------------- | ---------------------------------------------------------- |
| collaboration\_id | str | Box collaboration ID |
| name | str | Collaboration display label |
| created\_at | Optional\[datetime] | When the collaboration was created |
| updated\_at | Optional\[datetime] | When the collaboration was last modified |
| role | str | Role of the collaborator (editor, viewer, previewer, etc.) |
| accessible\_by | Dict | User or group that this collaboration applies to |
| item | Dict | File or folder that is being collaborated on |
| item\_id | str | ID of the item being collaborated on |
| item\_type | str | Type of the item (file or folder) |
| item\_name | str | Name of the item being collaborated on |
| status | str | Status of the collaboration (accepted, pending, etc.) |
| created\_by | Optional\[Dict] | User who created this collaboration |
| expires\_at | Optional\[Any] | When this collaboration expires |
| is\_access\_only | Optional\[bool] | Whether this is an access-only collaboration |
| invite\_email | Optional\[str] | Email address invited to collaborate |
| acknowledged\_at | Optional\[Any] | When the collaboration was acknowledged |
{/* AUTO-GENERATED CONTENT END */}