diff --git a/docs/en/enterprise/integrations/google_contacts.mdx b/docs/en/enterprise/integrations/google_contacts.mdx index 2e8de6aaf..755c86b49 100644 --- a/docs/en/enterprise/integrations/google_contacts.mdx +++ b/docs/en/enterprise/integrations/google_contacts.mdx @@ -224,6 +224,60 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - `groupFields` (string, optional): Fields to include (e.g., 'name,memberCount,clientData'). Default: name,memberCount + + + **Description:** Get a specific contact group by resource name. + + **Parameters:** + - `resourceName` (string, required): The resource name of the contact group (e.g., 'contactGroups/myContactGroup') + - `maxMembers` (integer, optional): Maximum number of members to include. Minimum: 0, Maximum: 20000 + - `groupFields` (string, optional): Fields to include (e.g., 'name,memberCount,clientData'). Default: name,memberCount + + + + + **Description:** Create a new contact group (label). + + **Parameters:** + - `name` (string, required): The name of the contact group + - `clientData` (array, optional): Client-specific data + ```json + [ + { + "key": "data_key", + "value": "data_value" + } + ] + ``` + + + + + **Description:** Update a contact group's information. + + **Parameters:** + - `resourceName` (string, required): The resource name of the contact group (e.g., 'contactGroups/myContactGroup') + - `name` (string, required): The name of the contact group + - `clientData` (array, optional): Client-specific data + ```json + [ + { + "key": "data_key", + "value": "data_value" + } + ] + ``` + + + + + **Description:** Delete a contact group. + + **Parameters:** + - `resourceName` (string, required): The resource name of the contact group to delete (e.g., 'contactGroups/myContactGroup') + - `deleteContacts` (boolean, optional): Whether to delete contacts in the group as well. Default: false + + ## Usage Examples diff --git a/docs/en/enterprise/integrations/google_docs.mdx b/docs/en/enterprise/integrations/google_docs.mdx index 0445cfe79..2cfc4fc51 100644 --- a/docs/en/enterprise/integrations/google_docs.mdx +++ b/docs/en/enterprise/integrations/google_docs.mdx @@ -132,6 +132,297 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - `endIndex` (integer, required): The end index of the range. + + + **Description:** Create a new Google Document with content in one action. + + **Parameters:** + - `title` (string, required): The title for the new document. Appears at the top of the document and in Google Drive. + - `content` (string, optional): The text content to insert into the document. Use `\n` for new paragraphs. + + + + + **Description:** Append text to the end of a Google Document. Automatically inserts at the document end without needing to specify an index. + + **Parameters:** + - `documentId` (string, required): The document ID from create_document response or URL. + - `text` (string, required): Text to append at the end of the document. Use `\n` for new paragraphs. + + + + + **Description:** Make text bold or remove bold formatting in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to format. + - `endIndex` (integer, required): End position of text to format (exclusive). + - `bold` (boolean, required): Set `true` to make bold, `false` to remove bold. + + + + + **Description:** Make text italic or remove italic formatting in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to format. + - `endIndex` (integer, required): End position of text to format (exclusive). + - `italic` (boolean, required): Set `true` to make italic, `false` to remove italic. + + + + + **Description:** Add or remove underline formatting from text in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to format. + - `endIndex` (integer, required): End position of text to format (exclusive). + - `underline` (boolean, required): Set `true` to underline, `false` to remove underline. + + + + + **Description:** Add or remove strikethrough formatting from text in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to format. + - `endIndex` (integer, required): End position of text to format (exclusive). + - `strikethrough` (boolean, required): Set `true` to add strikethrough, `false` to remove. + + + + + **Description:** Change the font size of text in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to format. + - `endIndex` (integer, required): End position of text to format (exclusive). + - `fontSize` (number, required): Font size in points. Common sizes: 10, 11, 12, 14, 16, 18, 24, 36. + + + + + **Description:** Change the color of text using RGB values (0-1 scale) in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to format. + - `endIndex` (integer, required): End position of text to format (exclusive). + - `red` (number, required): Red component (0-1). Example: `1` for full red. + - `green` (number, required): Green component (0-1). Example: `0.5` for half green. + - `blue` (number, required): Blue component (0-1). Example: `0` for no blue. + + + + + **Description:** Turn existing text into a clickable hyperlink in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of text to make into a link. + - `endIndex` (integer, required): End position of text to make into a link (exclusive). + - `url` (string, required): The URL the link should point to. Example: `"https://example.com"`. + + + + + **Description:** Apply a heading or paragraph style to a text range in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of paragraph(s) to style. + - `endIndex` (integer, required): End position of paragraph(s) to style. + - `style` (string, required): The style to apply. Enum: `NORMAL_TEXT`, `TITLE`, `SUBTITLE`, `HEADING_1`, `HEADING_2`, `HEADING_3`, `HEADING_4`, `HEADING_5`, `HEADING_6`. + + + + + **Description:** Set text alignment for paragraphs in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of paragraph(s) to align. + - `endIndex` (integer, required): End position of paragraph(s) to align. + - `alignment` (string, required): Text alignment. Enum: `START` (left), `CENTER`, `END` (right), `JUSTIFIED`. + + + + + **Description:** Set line spacing for paragraphs in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of paragraph(s). + - `endIndex` (integer, required): End position of paragraph(s). + - `lineSpacing` (number, required): Line spacing as percentage. `100` = single, `115` = 1.15x, `150` = 1.5x, `200` = double. + + + + + **Description:** Convert paragraphs to a bulleted or numbered list in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of paragraphs to convert to list. + - `endIndex` (integer, required): End position of paragraphs to convert to list. + - `bulletPreset` (string, required): Bullet/numbering style. Enum: `BULLET_DISC_CIRCLE_SQUARE`, `BULLET_DIAMONDX_ARROW3D_SQUARE`, `BULLET_CHECKBOX`, `BULLET_ARROW_DIAMOND_DISC`, `BULLET_STAR_CIRCLE_SQUARE`, `NUMBERED_DECIMAL_ALPHA_ROMAN`, `NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS`, `NUMBERED_DECIMAL_NESTED`, `NUMBERED_UPPERALPHA_ALPHA_ROMAN`, `NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL`. + + + + + **Description:** Remove bullets or numbering from paragraphs in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `startIndex` (integer, required): Start position of list paragraphs. + - `endIndex` (integer, required): End position of list paragraphs. + + + + + **Description:** Insert a table with content into a Google Document in one action. Provide content as a 2D array. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `rows` (integer, required): Number of rows in the table. + - `columns` (integer, required): Number of columns in the table. + - `index` (integer, optional): Position to insert the table. If not provided, the table is inserted at the end of the document. + - `content` (array, required): Table content as a 2D array. Each inner array is a row. Example: `[["Year", "Revenue"], ["2023", "$43B"], ["2024", "$45B"]]`. + + + + + **Description:** Insert a new row above or below a reference cell in an existing table. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `tableStartIndex` (integer, required): The start index of the table. Get from get_document. + - `rowIndex` (integer, required): Row index (0-based) of reference cell. + - `columnIndex` (integer, optional): Column index (0-based) of reference cell. Default is `0`. + - `insertBelow` (boolean, optional): If `true`, insert below the reference row. If `false`, insert above. Default is `true`. + + + + + **Description:** Insert a new column left or right of a reference cell in an existing table. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `tableStartIndex` (integer, required): The start index of the table. + - `rowIndex` (integer, optional): Row index (0-based) of reference cell. Default is `0`. + - `columnIndex` (integer, required): Column index (0-based) of reference cell. + - `insertRight` (boolean, optional): If `true`, insert to the right. If `false`, insert to the left. Default is `true`. + + + + + **Description:** Delete a row from an existing table in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `tableStartIndex` (integer, required): The start index of the table. + - `rowIndex` (integer, required): Row index (0-based) to delete. + - `columnIndex` (integer, optional): Column index (0-based) of any cell in the row. Default is `0`. + + + + + **Description:** Delete a column from an existing table in a Google Document. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `tableStartIndex` (integer, required): The start index of the table. + - `rowIndex` (integer, optional): Row index (0-based) of any cell in the column. Default is `0`. + - `columnIndex` (integer, required): Column index (0-based) to delete. + + + + + **Description:** Merge a range of table cells into a single cell. Content from all cells is preserved. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `tableStartIndex` (integer, required): The start index of the table. + - `rowIndex` (integer, required): Starting row index (0-based) for the merge. + - `columnIndex` (integer, required): Starting column index (0-based) for the merge. + - `rowSpan` (integer, required): Number of rows to merge. + - `columnSpan` (integer, required): Number of columns to merge. + + + + + **Description:** Unmerge previously merged table cells back into individual cells. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `tableStartIndex` (integer, required): The start index of the table. + - `rowIndex` (integer, required): Row index (0-based) of the merged cell. + - `columnIndex` (integer, required): Column index (0-based) of the merged cell. + - `rowSpan` (integer, required): Number of rows the merged cell spans. + - `columnSpan` (integer, required): Number of columns the merged cell spans. + + + + + **Description:** Insert an image from a public URL into a Google Document. The image must be publicly accessible, under 50MB, and in PNG/JPEG/GIF format. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `uri` (string, required): Public URL of the image. Must be accessible without authentication. + - `index` (integer, optional): Position to insert the image. If not provided, the image is inserted at the end of the document. Default is `1`. + + + + + **Description:** Insert a section break to create document sections with different formatting. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `index` (integer, required): Position to insert the section break. + - `sectionType` (string, required): The type of section break. Enum: `CONTINUOUS` (stays on same page), `NEXT_PAGE` (starts a new page). + + + + + **Description:** Create a header for the document. Returns a headerId which can be used with insert_text to add header content. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `type` (string, optional): Header type. Enum: `DEFAULT`. Default is `DEFAULT`. + + + + + **Description:** Create a footer for the document. Returns a footerId which can be used with insert_text to add footer content. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `type` (string, optional): Footer type. Enum: `DEFAULT`. Default is `DEFAULT`. + + + + + **Description:** Delete a header from the document. Use get_document to find the headerId. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `headerId` (string, required): The header ID to delete. Get from get_document response. + + + + + **Description:** Delete a footer from the document. Use get_document to find the footerId. + + **Parameters:** + - `documentId` (string, required): The document ID. + - `footerId` (string, required): The footer ID to delete. Get from get_document response. + + ## Usage Examples diff --git a/docs/en/enterprise/integrations/google_slides.mdx b/docs/en/enterprise/integrations/google_slides.mdx index 350d21bf9..20efe0a0a 100644 --- a/docs/en/enterprise/integrations/google_slides.mdx +++ b/docs/en/enterprise/integrations/google_slides.mdx @@ -62,6 +62,22 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token + + **Description:** Get lightweight metadata about a presentation (title, slide count, slide IDs). Use this first before fetching full content. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation to retrieve. + + + + + **Description:** Extract all text content from a presentation. Returns slide IDs and text from shapes and tables only (no formatting). + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + + + **Description:** Retrieves a presentation by ID. @@ -96,6 +112,15 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token + + **Description:** Extract text content from a single slide. Returns only text from shapes and tables (no formatting or styling). + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `pageObjectId` (string, required): The ID of the slide/page to get text from. + + + **Description:** Retrieves a specific page by its ID. @@ -114,6 +139,120 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token + + **Description:** Add an additional blank slide to a presentation. New presentations already have one blank slide - check get_presentation_metadata first. For slides with title/body areas, use create_slide_with_layout instead. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `insertionIndex` (integer, optional): Where to insert the slide (0-based). If omitted, adds at the end. + + + + + **Description:** Create a slide with a predefined layout containing placeholder areas for title, body, etc. This is better than create_slide for structured content. After creating, use get_page to find placeholder IDs, then insert text into them. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `layout` (string, required): Layout type. One of: `BLANK`, `TITLE`, `TITLE_AND_BODY`, `TITLE_AND_TWO_COLUMNS`, `TITLE_ONLY`, `SECTION_HEADER`, `ONE_COLUMN_TEXT`, `MAIN_POINT`, `BIG_NUMBER`. TITLE_AND_BODY is best for title+description. TITLE for title-only slides. SECTION_HEADER for section dividers. + - `insertionIndex` (integer, optional): Where to insert (0-based). Omit to add at end. + + + + + **Description:** Create a text box on a slide with content. Use this for titles, descriptions, paragraphs - not tables. Optionally specify position (x, y) and size (width, height) in EMU units (914400 EMU = 1 inch). + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The ID of the slide to add the text box to. + - `text` (string, required): The text content for the text box. + - `x` (integer, optional): X position in EMU (914400 = 1 inch). Default: 914400 (1 inch from left). + - `y` (integer, optional): Y position in EMU (914400 = 1 inch). Default: 914400 (1 inch from top). + - `width` (integer, optional): Width in EMU. Default: 7315200 (~8 inches). + - `height` (integer, optional): Height in EMU. Default: 914400 (~1 inch). + + + + + **Description:** Remove a slide from the presentation. Use get_presentation first to find the slide ID. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The object ID of the slide to delete. Get from get_presentation. + + + + + **Description:** Create a copy of an existing slide. The duplicate is inserted immediately after the original. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The object ID of the slide to duplicate. Get from get_presentation. + + + + + **Description:** Reorder slides by moving them to a new position. Slide IDs must be in their current presentation order (no duplicates). + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideIds` (array of strings, required): Array of slide IDs to move. Must be in current presentation order. + - `insertionIndex` (integer, required): Target position (0-based). 0 = beginning, slide count = end. + + + + + **Description:** Embed a YouTube video on a slide. The video ID is the value after "v=" in YouTube URLs (e.g., for youtube.com/watch?v=abc123, use "abc123"). + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The ID of the slide to add the video to. Get from get_presentation. + - `videoId` (string, required): The YouTube video ID (the value after v= in the URL). + + + + + **Description:** Embed a video from Google Drive on a slide. The file ID can be found in the Drive file URL. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The ID of the slide to add the video to. Get from get_presentation. + - `fileId` (string, required): The Google Drive file ID of the video. + + + + + **Description:** Set a background image for a slide. The image URL must be publicly accessible. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The ID of the slide to set the background for. Get from get_presentation. + - `imageUrl` (string, required): Publicly accessible URL of the image to use as background. + + + + + **Description:** Create an empty table on a slide. To create a table with content, use create_table_with_content instead. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The ID of the slide to add the table to. Get from get_presentation. + - `rows` (integer, required): Number of rows in the table. + - `columns` (integer, required): Number of columns in the table. + + + + + **Description:** Create a table with content in one action. Provide content as a 2D array where each inner array is a row. Example: [["Header1", "Header2"], ["Row1Col1", "Row1Col2"]]. + + **Parameters:** + - `presentationId` (string, required): The ID of the presentation. + - `slideId` (string, required): The ID of the slide to add the table to. Get from get_presentation. + - `rows` (integer, required): Number of rows in the table. + - `columns` (integer, required): Number of columns in the table. + - `content` (array, required): Table content as 2D array. Each inner array is a row. Example: [["Year", "Revenue"], ["2023", "$10M"]]. + + + **Description:** Imports data from a Google Sheet into a presentation. diff --git a/docs/en/enterprise/integrations/microsoft_excel.mdx b/docs/en/enterprise/integrations/microsoft_excel.mdx index 233131c1c..d0fadb7c7 100644 --- a/docs/en/enterprise/integrations/microsoft_excel.mdx +++ b/docs/en/enterprise/integrations/microsoft_excel.mdx @@ -169,6 +169,16 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token + + **Description:** Get data from a specific table in an Excel worksheet. + + **Parameters:** + - `file_id` (string, required): The ID of the Excel file + - `worksheet_name` (string, required): Name of the worksheet + - `table_name` (string, required): Name of the table + + + **Description:** Create a chart in an Excel worksheet. @@ -201,6 +211,15 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token + + **Description:** Get the used range metadata (dimensions only, no data) of an Excel worksheet. + + **Parameters:** + - `file_id` (string, required): The ID of the Excel file + - `worksheet_name` (string, required): Name of the worksheet + + + **Description:** Get all charts in an Excel worksheet. diff --git a/docs/en/enterprise/integrations/microsoft_onedrive.mdx b/docs/en/enterprise/integrations/microsoft_onedrive.mdx index 030ed22ed..30d8077e8 100644 --- a/docs/en/enterprise/integrations/microsoft_onedrive.mdx +++ b/docs/en/enterprise/integrations/microsoft_onedrive.mdx @@ -151,6 +151,49 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - `item_id` (string, required): The ID of the file. + + + **Description:** List files and folders in a specific OneDrive path. + + **Parameters:** + - `folder_path` (string, required): The folder path (e.g., 'Documents/Reports'). + - `top` (integer, optional): Number of items to retrieve (max 1000). Default is `50`. + - `orderby` (string, optional): Order by field (e.g., "name asc", "lastModifiedDateTime desc"). Default is "name asc". + + + + + **Description:** Get recently accessed files from OneDrive. + + **Parameters:** + - `top` (integer, optional): Number of items to retrieve (max 200). Default is `25`. + + + + + **Description:** Get files and folders shared with the user. + + **Parameters:** + - `top` (integer, optional): Number of items to retrieve (max 200). Default is `50`. + - `orderby` (string, optional): Order by field. Default is "name asc". + + + + + **Description:** Get information about a specific file or folder by path. + + **Parameters:** + - `file_path` (string, required): The file or folder path (e.g., 'Documents/report.docx'). + + + + + **Description:** Download a file from OneDrive by its path. + + **Parameters:** + - `file_path` (string, required): The file path (e.g., 'Documents/report.docx'). + + ## Usage Examples diff --git a/docs/en/enterprise/integrations/microsoft_outlook.mdx b/docs/en/enterprise/integrations/microsoft_outlook.mdx index 50a8a3085..c25d18e82 100644 --- a/docs/en/enterprise/integrations/microsoft_outlook.mdx +++ b/docs/en/enterprise/integrations/microsoft_outlook.mdx @@ -133,6 +133,74 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - `companyName` (string, optional): Contact's company name. + + + **Description:** Get a specific email message by ID. + + **Parameters:** + - `message_id` (string, required): The unique identifier of the message. Obtain from get_messages action. + - `select` (string, optional): Comma-separated list of properties to return. Example: "id,subject,body,from,receivedDateTime". Default is "id,subject,body,from,toRecipients,receivedDateTime". + + + + + **Description:** Reply to an email message. + + **Parameters:** + - `message_id` (string, required): The unique identifier of the message to reply to. Obtain from get_messages action. + - `comment` (string, required): The reply message content. Can be plain text or HTML. The original message will be quoted below this content. + + + + + **Description:** Forward an email message. + + **Parameters:** + - `message_id` (string, required): The unique identifier of the message to forward. Obtain from get_messages action. + - `to_recipients` (array, required): Array of recipient email addresses to forward to. Example: ["john@example.com", "jane@example.com"]. + - `comment` (string, optional): Optional message to include above the forwarded content. Can be plain text or HTML. + + + + + **Description:** Mark a message as read or unread. + + **Parameters:** + - `message_id` (string, required): The unique identifier of the message. Obtain from get_messages action. + - `is_read` (boolean, required): Set to true to mark as read, false to mark as unread. + + + + + **Description:** Delete an email message. + + **Parameters:** + - `message_id` (string, required): The unique identifier of the message to delete. Obtain from get_messages action. + + + + + **Description:** Update an existing calendar event. + + **Parameters:** + - `event_id` (string, required): The unique identifier of the event. Obtain from get_calendar_events action. + - `subject` (string, optional): New subject/title for the event. + - `start_time` (string, optional): New start time in ISO 8601 format (e.g., "2024-01-20T10:00:00"). REQUIRED: Must also provide start_timezone when using this field. + - `start_timezone` (string, optional): Timezone for start time. REQUIRED when updating start_time. Examples: "Pacific Standard Time", "Eastern Standard Time", "UTC". + - `end_time` (string, optional): New end time in ISO 8601 format. REQUIRED: Must also provide end_timezone when using this field. + - `end_timezone` (string, optional): Timezone for end time. REQUIRED when updating end_time. Examples: "Pacific Standard Time", "Eastern Standard Time", "UTC". + - `location` (string, optional): New location for the event. + - `body` (string, optional): New body/description for the event. Supports HTML formatting. + + + + + **Description:** Delete a calendar event. + + **Parameters:** + - `event_id` (string, required): The unique identifier of the event to delete. Obtain from get_calendar_events action. + + ## Usage Examples diff --git a/docs/en/enterprise/integrations/microsoft_sharepoint.mdx b/docs/en/enterprise/integrations/microsoft_sharepoint.mdx index 1ffa75c6c..ab5f310f3 100644 --- a/docs/en/enterprise/integrations/microsoft_sharepoint.mdx +++ b/docs/en/enterprise/integrations/microsoft_sharepoint.mdx @@ -78,6 +78,17 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token + + **Description:** List all document libraries (drives) in a SharePoint site. Use this to discover available libraries before using file operations. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `top` (integer, optional): Maximum number of drives to return per page (1-999). Default is 100 + - `skip_token` (string, optional): Pagination token from a previous response to fetch the next page of results + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'id,name,webUrl,driveType') + + + **Description:** Get all lists in a SharePoint site. @@ -159,20 +170,317 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - - **Description:** Get files and folders from a SharePoint document library. + + **Description:** Retrieve files and folders from a SharePoint document library. By default lists the root folder, but you can navigate into subfolders by providing a folder_id. **Parameters:** - - `site_id` (string, required): The ID of the SharePoint site + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `folder_id` (string, optional): The ID of the folder to list contents from. Use 'root' for the root folder, or provide a folder ID from a previous list_files call. Default is 'root' + - `top` (integer, optional): Maximum number of items to return per page (1-1000). Default is 50 + - `skip_token` (string, optional): Pagination token from a previous response to fetch the next page of results + - `orderby` (string, optional): Sort order for results (e.g., 'name asc', 'size desc', 'lastModifiedDateTime desc'). Default is 'name asc' + - `filter` (string, optional): OData filter to narrow results (e.g., 'file ne null' for files only, 'folder ne null' for folders only) + - `select` (string, optional): Comma-separated list of fields to return (e.g., 'id,name,size,folder,file,webUrl,lastModifiedDateTime') - - **Description:** Delete a file or folder from SharePoint document library. + + **Description:** Delete a file or folder from a SharePoint document library. For folders, all contents are deleted recursively. Items are moved to the site recycle bin. **Parameters:** - - `site_id` (string, required): The ID of the SharePoint site - - `item_id` (string, required): The ID of the file or folder to delete + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the file or folder to delete. Obtain from list_files + + + + + **Description:** List files and folders in a SharePoint document library folder by its path. More efficient than multiple list_files calls for deep navigation. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `folder_path` (string, required): The full path to the folder without leading/trailing slashes (e.g., 'Documents', 'Reports/2024/Q1') + - `top` (integer, optional): Maximum number of items to return per page (1-1000). Default is 50 + - `skip_token` (string, optional): Pagination token from a previous response to fetch the next page of results + - `orderby` (string, optional): Sort order for results (e.g., 'name asc', 'size desc'). Default is 'name asc' + - `select` (string, optional): Comma-separated list of fields to return (e.g., 'id,name,size,folder,file,webUrl,lastModifiedDateTime') + + + + + **Description:** Download raw file content from a SharePoint document library. Use only for plain text files (.txt, .csv, .json). For Excel files, use the Excel-specific actions. For Word files, use get_word_document_content. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the file to download. Obtain from list_files or list_files_by_path + + + + + **Description:** Retrieve detailed metadata for a specific file or folder in a SharePoint document library, including name, size, created/modified dates, and author information. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the file or folder. Obtain from list_files or list_files_by_path + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'id,name,size,createdDateTime,lastModifiedDateTime,webUrl,createdBy,lastModifiedBy') + + + + + **Description:** Create a new folder in a SharePoint document library. By default creates the folder in the root; use parent_id to create subfolders. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `folder_name` (string, required): Name for the new folder. Cannot contain: \ / : * ? " < > | + - `parent_id` (string, optional): The ID of the parent folder. Use 'root' for the document library root, or provide a folder ID from list_files. Default is 'root' + + + + + **Description:** Search for files and folders in a SharePoint document library by keywords. Searches file names, folder names, and file contents for Office documents. Do not use wildcards or special characters. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `query` (string, required): Search keywords (e.g., 'report', 'budget 2024'). Wildcards like *.txt are not supported + - `top` (integer, optional): Maximum number of results to return per page (1-1000). Default is 50 + - `skip_token` (string, optional): Pagination token from a previous response to fetch the next page of results + - `select` (string, optional): Comma-separated list of fields to return (e.g., 'id,name,size,folder,file,webUrl,lastModifiedDateTime') + + + + + **Description:** Copy a file or folder to a new location within SharePoint. The original item remains unchanged. The copy operation is asynchronous for large files. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the file or folder to copy. Obtain from list_files or search_files + - `destination_folder_id` (string, required): The ID of the destination folder. Use 'root' for the root folder, or a folder ID from list_files + - `new_name` (string, optional): New name for the copy. If not provided, the original name is used + + + + + **Description:** Move a file or folder to a new location within SharePoint. The item is removed from its original location. For folders, all contents are moved as well. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the file or folder to move. Obtain from list_files or search_files + - `destination_folder_id` (string, required): The ID of the destination folder. Use 'root' for the root folder, or a folder ID from list_files + - `new_name` (string, optional): New name for the moved item. If not provided, the original name is kept + + + + + **Description:** List all worksheets (tabs) in an Excel workbook stored in a SharePoint document library. Use the returned worksheet name with other Excel actions. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'id,name,position,visibility') + - `filter` (string, optional): OData filter expression (e.g., "visibility eq 'Visible'" to exclude hidden sheets) + - `top` (integer, optional): Maximum number of worksheets to return. Minimum: 1, Maximum: 999 + - `orderby` (string, optional): Sort order (e.g., 'position asc' to return sheets in tab order) + + + + + **Description:** Create a new worksheet (tab) in an Excel workbook stored in a SharePoint document library. The new sheet is added at the end of the tab list. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `name` (string, required): Name for the new worksheet. Maximum 31 characters. Cannot contain: \ / * ? : [ ]. Must be unique within the workbook + + + + + **Description:** Retrieve cell values from a specific range in an Excel worksheet stored in SharePoint. For reading all data without knowing dimensions, use get_excel_used_range instead. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet (tab) to read from. Obtain from get_excel_worksheets. Case-sensitive + - `range` (string, required): Cell range in A1 notation (e.g., 'A1:C10', 'A:C', '1:5', 'A1') + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'address,values,formulas,numberFormat,text') + + + + + **Description:** Write values to a specific range in an Excel worksheet stored in SharePoint. Overwrites existing cell contents. The values array dimensions must match the range dimensions exactly. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet (tab) to update. Obtain from get_excel_worksheets. Case-sensitive + - `range` (string, required): Cell range in A1 notation where values will be written (e.g., 'A1:C3' for a 3x3 block) + - `values` (array, required): 2D array of values (rows containing cells). Example for A1:B2: [["Header1", "Header2"], ["Value1", "Value2"]]. Use null to clear a cell + + + + + **Description:** Return only the metadata (address and dimensions) of the used range in a worksheet, without the actual cell values. Ideal for large files to understand spreadsheet size before reading data in chunks. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet (tab) to read. Obtain from get_excel_worksheets. Case-sensitive + + + + + **Description:** Retrieve all cells containing data in a worksheet stored in SharePoint. Do not use for files larger than 2MB. For large files, use get_excel_used_range_metadata first, then get_excel_range_data to read in smaller chunks. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet (tab) to read. Obtain from get_excel_worksheets. Case-sensitive + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'address,values,formulas,numberFormat,text,rowCount,columnCount') + + + + + **Description:** Retrieve the value of a single cell by row and column index from an Excel file in SharePoint. Indices are 0-based (row 0 = Excel row 1, column 0 = column A). + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet (tab). Obtain from get_excel_worksheets. Case-sensitive + - `row` (integer, required): 0-based row index (row 0 = Excel row 1). Valid range: 0-1048575 + - `column` (integer, required): 0-based column index (column 0 = A, column 1 = B). Valid range: 0-16383 + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'address,values,formulas,numberFormat,text') + + + + + **Description:** Convert a cell range into a formatted Excel table with filtering, sorting, and structured data capabilities. Tables enable add_excel_table_row for appending data. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet containing the data range. Obtain from get_excel_worksheets + - `range` (string, required): Cell range to convert into a table, including headers and data (e.g., 'A1:D10' where A1:D1 contains column headers) + - `has_headers` (boolean, optional): Set to true if the first row contains column headers. Default is true + + + + + **Description:** List all tables in a specific Excel worksheet stored in SharePoint. Returns table properties including id, name, showHeaders, and showTotals. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet to get tables from. Obtain from get_excel_worksheets + + + + + **Description:** Append a new row to the end of an Excel table in a SharePoint file. The values array must have the same number of elements as the table has columns. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet containing the table. Obtain from get_excel_worksheets + - `table_name` (string, required): Name of the table to add the row to (e.g., 'Table1'). Obtain from get_excel_tables. Case-sensitive + - `values` (array, required): Array of cell values for the new row, one per column in table order (e.g., ["John Doe", "john@example.com", 25]) + + + + + **Description:** Get all rows from an Excel table in a SharePoint file as a data range. Easier than get_excel_range_data when working with structured tables since you don't need to know the exact range. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet containing the table. Obtain from get_excel_worksheets + - `table_name` (string, required): Name of the table to get data from (e.g., 'Table1'). Obtain from get_excel_tables. Case-sensitive + - `select` (string, optional): Comma-separated list of properties to return (e.g., 'address,values,formulas,numberFormat,text') + + + + + **Description:** Create a chart visualization in an Excel worksheet stored in SharePoint from a data range. The chart is embedded in the worksheet. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet where the chart will be created. Obtain from get_excel_worksheets + - `chart_type` (string, required): Chart type (e.g., 'ColumnClustered', 'ColumnStacked', 'Line', 'LineMarkers', 'Pie', 'Bar', 'BarClustered', 'Area', 'Scatter', 'Doughnut') + - `source_data` (string, required): Data range for the chart in A1 notation, including headers (e.g., 'A1:B10') + - `series_by` (string, optional): How data series are organized: 'Auto', 'Columns', or 'Rows'. Default is 'Auto' + + + + + **Description:** List all charts embedded in an Excel worksheet stored in SharePoint. Returns chart properties including id, name, chartType, height, width, and position. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet to list charts from. Obtain from get_excel_worksheets + + + + + **Description:** Permanently remove a worksheet (tab) and all its contents from an Excel workbook stored in SharePoint. Cannot be undone. A workbook must have at least one worksheet. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet to delete. Case-sensitive. All data, tables, and charts on this sheet will be permanently removed + + + + + **Description:** Remove a table from an Excel worksheet in SharePoint. This deletes the table structure (filtering, formatting, table features) but preserves the underlying cell data. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + - `worksheet_name` (string, required): Name of the worksheet containing the table. Obtain from get_excel_worksheets + - `table_name` (string, required): Name of the table to delete (e.g., 'Table1'). Obtain from get_excel_tables. The data in the cells will remain after table deletion + + + + + **Description:** Retrieve all named ranges defined in an Excel workbook stored in SharePoint. Named ranges are user-defined labels for cell ranges (e.g., 'SalesData' for A1:D100). + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Excel file in SharePoint. Obtain from list_files or search_files + + + + + **Description:** Download and extract text content from a Word document (.docx) stored in a SharePoint document library. This is the recommended way to read Word documents from SharePoint. + + **Parameters:** + - `site_id` (string, required): The full SharePoint site identifier from get_sites + - `drive_id` (string, required): The ID of the document library. Call get_drives first to get valid drive IDs + - `item_id` (string, required): The unique identifier of the Word document (.docx) in SharePoint. Obtain from list_files or search_files diff --git a/docs/en/enterprise/integrations/microsoft_teams.mdx b/docs/en/enterprise/integrations/microsoft_teams.mdx index f77d58ebd..1681bc4b4 100644 --- a/docs/en/enterprise/integrations/microsoft_teams.mdx +++ b/docs/en/enterprise/integrations/microsoft_teams.mdx @@ -108,6 +108,86 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - `join_web_url` (string, required): The join web URL of the meeting to search for. + + + **Description:** Search online meetings by external Meeting ID. + + **Parameters:** + - `join_meeting_id` (string, required): The meeting ID (numeric code) that attendees use to join. This is the joinMeetingId shown in meeting invitations, not the Graph API meeting id. + + + + + **Description:** Get details of a specific online meeting. + + **Parameters:** + - `meeting_id` (string, required): The Graph API meeting ID (a long alphanumeric string). Obtain from create_meeting or search_online_meetings actions. Different from the numeric joinMeetingId. + + + + + **Description:** Get members of a specific team. + + **Parameters:** + - `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action. + - `top` (integer, optional): Maximum number of members to retrieve per page (1-999). Default is `100`. + - `skip_token` (string, optional): Pagination token from a previous response. When the response includes @odata.nextLink, extract the $skiptoken parameter value and pass it here to get the next page of results. + + + + + **Description:** Create a new channel in a team. + + **Parameters:** + - `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action. + - `display_name` (string, required): Name of the channel as displayed in Teams. Must be unique within the team. Max 50 characters. + - `description` (string, optional): Optional description explaining the channel's purpose. Visible in channel details. Max 1024 characters. + - `membership_type` (string, optional): Channel visibility. Enum: `standard`, `private`. "standard" = visible to all team members, "private" = visible only to specifically added members. Default is `standard`. + + + + + **Description:** Get replies to a specific message in a channel. + + **Parameters:** + - `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action. + - `channel_id` (string, required): The unique identifier of the channel. Obtain from get_channels action. + - `message_id` (string, required): The unique identifier of the parent message. Obtain from get_messages action. + - `top` (integer, optional): Maximum number of replies to retrieve per page (1-50). Default is `50`. + - `skip_token` (string, optional): Pagination token from a previous response. When the response includes @odata.nextLink, extract the $skiptoken parameter value and pass it here to get the next page of results. + + + + + **Description:** Reply to a message in a Teams channel. + + **Parameters:** + - `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action. + - `channel_id` (string, required): The unique identifier of the channel. Obtain from get_channels action. + - `message_id` (string, required): The unique identifier of the message to reply to. Obtain from get_messages action. + - `message` (string, required): The reply content. For HTML, include formatting tags. For text, plain text only. + - `content_type` (string, optional): Content format. Enum: `html`, `text`. "text" for plain text, "html" for rich text with formatting. Default is `text`. + + + + + **Description:** Update an existing online meeting. + + **Parameters:** + - `meeting_id` (string, required): The unique identifier of the meeting. Obtain from create_meeting or search_online_meetings actions. + - `subject` (string, optional): New meeting title. + - `startDateTime` (string, optional): New start time in ISO 8601 format with timezone. Example: "2024-01-20T10:00:00-08:00". + - `endDateTime` (string, optional): New end time in ISO 8601 format with timezone. + + + + + **Description:** Delete an online meeting. + + **Parameters:** + - `meeting_id` (string, required): The unique identifier of the meeting to delete. Obtain from create_meeting or search_online_meetings actions. + + ## Usage Examples diff --git a/docs/en/enterprise/integrations/microsoft_word.mdx b/docs/en/enterprise/integrations/microsoft_word.mdx index e83280e99..7b7675b2e 100644 --- a/docs/en/enterprise/integrations/microsoft_word.mdx +++ b/docs/en/enterprise/integrations/microsoft_word.mdx @@ -98,6 +98,26 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token - `file_id` (string, required): The ID of the document to delete. + + + **Description:** Copy a document to a new location in OneDrive. + + **Parameters:** + - `file_id` (string, required): The ID of the document to copy + - `name` (string, optional): New name for the copied document + - `parent_id` (string, optional): The ID of the destination folder (defaults to root) + + + + + **Description:** Move a document to a new location in OneDrive. + + **Parameters:** + - `file_id` (string, required): The ID of the document to move + - `parent_id` (string, required): The ID of the destination folder + - `name` (string, optional): New name for the moved document + + ## Usage Examples