Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Fix file upload ts doc snippets (#2414)

Musthaq Ahamad3b2ad6d31530
diff --git a/ts/packages/core/src/models/Files.node.ts b/ts/packages/core/src/models/Files.node.ts
index 3f32e14f0..2c5561f94 100644
--- a/ts/packages/core/src/models/Files.node.ts
+++ b/ts/packages/core/src/models/Files.node.ts
@@ -16,12 +16,22 @@ export class Files {
}
/**
- * Upload a file to S3 and return the file data.
- * @param filePath - The path to the file to upload or a URL of the file to upload.
- * @param toolSlug - The slug of the tool that is uploading the file.
- * @param toolkitSlug - The slug of the toolkit that is uploading the file.
- * @returns The file data.
- */
+ * 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,