Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
/**
* @fileoverview Files class for Composio SDK, used to manage files.
*
* @author Musthaq Ahamad <[email protected]>
* @date 2025-06-23
* @module Files
*/
import ComposioClient from '@composio/client';
import { FileDownloadData, FileUploadData } from '../types/files.types';
import { downloadFileFromS3, getFileDataAfterUploadingToS3 } from '../utils/fileUtils.node';
import { telemetry } from '../telemetry/Telemetry';
export class Files {
private readonly fileOptions: {
sensitiveFileUploadProtection?: boolean;
fileUploadPathDenySegments?: string[];
fileDownloadDir?: string;
};
constructor(
private readonly client: ComposioClient,
fileOptions: {
sensitiveFileUploadProtection?: boolean;
fileUploadPathDenySegments?: string[];
fileDownloadDir?: string;
} = {}
) {
this.fileOptions = fileOptions;
telemetry.instrument(this, 'Files');
}
/**
* Upload a file and return the file data.
*
* @param params - The upload parameters.
* @param {File | string} params.file - The path to the file to upload, a URL of the file, or a File object.
* @param {string} params.toolSlug - The slug of the tool that is uploading the file.
* @param {string} params.toolkitSlug - The slug of the toolkit that is uploading the file.
* @returns {Promise<FileUploadData>} The uploaded file data.
*
* @example
*
* const fileData = await composio.files.upload({
* file: 'path/to/file.pdf',
* toolSlug: 'google_drive_upload',
* toolkitSlug: 'google_drive'
* });
* */
async upload({
file,
toolSlug,
toolkitSlug,
}: {
file: File | string;
toolSlug: string;
toolkitSlug: string;
}): Promise<FileUploadData> {
// Note: manual `composio.files.upload()` intentionally skips the
// `fileUploadDirs` allowlist. The allowlist only gates *automatic* upload
// during tool execution (see FileToolModifier).
const fileData = await getFileDataAfterUploadingToS3(file, {
toolSlug,
toolkitSlug,
client: this.client,
sensitiveFileUploadProtection: this.fileOptions.sensitiveFileUploadProtection,
fileUploadPathDenySegments: this.fileOptions.fileUploadPathDenySegments,
});
return fileData;
}
/**
* Download a file from S3 and return the file data.
* @param s3key - The S3 key of the file to download.
* @returns The file data.
*/
async download({
toolSlug,
s3Url,
mimeType,
}: {
s3Url: string;
toolSlug: string;
mimeType: string;
}): Promise<FileDownloadData> {
const fileDownloadData = await downloadFileFromS3({
toolSlug,
s3Url,
mimeType,
fileDownloadDir: this.fileOptions.fileDownloadDir,
});
return fileDownloadData;
}
}