> For the complete documentation index, see [llms.txt](https://exaprotocol.gitbook.io/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://exaprotocol.gitbook.io/home/getting-started/upload-files.md).
# Upload Files
### Uploading Files with ExaDrive SDK
The ExaDrive SDK provides a straightforward method for uploading files to the ExaDrive network. This functionality allows you to easily integrate file uploads into your application, with the added benefit of receiving detailed information about the uploaded file.
### Basic Usage
To upload a file, use the `uploadFile` method of your ExaDrive instance. This method takes the file path as an argument and returns a promise that resolves when the upload is complete.
### Syntax
```
exaDriveuploadFile(filePath: string, directoryPath: string)
```
* `filePath`: A string representing the path to the file you want to upload.
* `directoryPath`: A string which will represent the directory you want to put your file in.
### Example
# notice the preceding '/' in the directoryPath
exaDrive.uploadFile('path/to/file.png', '/myapp1/images')
.then((res) => {
console.log(res.data);
})
.catch((error) => {
console.error('Upload failed:', error);
});
### Response Structure
Upon successful upload, the promise resolves with a response object containing detailed information about the uploaded file.
### Sample Response
```
{
"filename": "file.png",
"fileDetails": {
"encoding": "7bit",
"mimetype": "image/png",
"size": 411663
},
"url": "https://12345678-w3.exadrivecdn.com/myapp1/images/file.png"
}
```
### Response Fields
* **filename**: The name of the uploaded file.
* **fileDetails**: An object containing technical details about the file:
* **encoding**: The encoding type of the file (e.g., "7bit").
* **mimetype**: The MIME type of the file (e.g., "image/png").
* **size**: The size of the file in bytes.
* **url**: The URL where the uploaded file can be accessed.
### Advanced Usage
### Batch Uploads
If you need to upload multiple files, you can use Promise.all():
```
const filePaths = ['file1.jpg', 'file2.pdf', 'file3.docx'];
Promise.all(filePaths.map(file => exaDrive.uploadFile(file, '/myapp1/images')))
.then((results) => {
results.forEach((res, index) => {
console.log(`File ${index + 1} uploaded:`, res.data);
});
})
.catch((error) => {
console.error('One or more uploads failed:', error);
});
```
### Best Practices
1. **Error Handling**: Always include error handling to manage potential upload failures gracefully.
2. **File Size Limits**: Be aware of any file size limits imposed by ExaDrive and handle them appropriately in your application.
3. **File Type Validation**: Implement client-side file type validation before uploading to ensure only permitted file types are sent.
4. **Secure File Handling**: Ensure that file paths are properly sanitized and validated to prevent security vulnerabilities.
5. **Retry Mechanism**: For improved reliability, especially with large files or unstable connections, implement a retry mechanism:
```
const uploadWithRetry = async (filePath, directoryPath, maxRetries = 3) => {
for (let attempt = 1; attempt <= maxRetries; attempt++) {
try {
const result = await exaDrive.uploadFile(filePath, directoryPath);
return result;
} catch (error) {
if (attempt === maxRetries) throw error;
console.log(`Upload attempt ${attempt} failed, retrying...`);
await new Promise(resolve => setTimeout(resolve, 1000 * attempt));
}
}
};
```
### `uploadMulterFile`
Using this function you can directly use Multer file object to upload a file. This is an alternative to uploadFile.
```
exaDrive.uploadMulterFile(file: any, virtualDirectoryPath: string)
.then(response => {
console.log('Multer file uploaded successfully:', response);
})
.catch(error => {
console.error('Error uploading Multer file:', error);
});
```
* **Parameters:**
* `file`: The request object containing the file data.
* `virtualDirectoryPath`: The path you want to set for the directory of the file.
### Sample Response
```
{
"filename": "file.png",
"fileDetails": {
"encoding": "7bit",
"mimetype": "image/png",
"size": 411663
},
"url": "https://12345678-w3.exadrivecdn.com/myapp1/images/file.png"
}
```
### `uploadFileWithBuffer`
The `uploadFileWithBuffer` function allows you to upload files using a buffer. This is useful when you have file data in memory and want to upload it directly without saving it to disk first.
```
exaDrive.uploadFileWithBuffer(buffer: Buffer, originalFileName: string, mimeType: string, virtualDirectoryPath: string)
.then(response => {
console.log('File uploaded with buffer successfully:', response);
})
.catch(error => {
console.error('Error uploading file with buffer:', error);
});
```
* **Parameters:**
* `buffer`: The buffer containing the file data.
* `originalFileName`: The original name of the file, this will help in locating the file on ExaDrive later.
* `mimeType`: The mime-type of the file.
* `virtualDirectoryPath`: The path you want to set for the directory of the file.
### Sample Response
```
{
"filename": "file.png",
"fileDetails": {
"encoding": "7bit",
"mimetype": "image/png",
"size": 411663
},
"url": "https://12345678-w3.exadrivecdn.com/myapp1/images/file.png"
}
```
By leveraging these upload capabilities and following best practices, you can efficiently manage file uploads in your application using the ExaDrive SDK.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://exaprotocol.gitbook.io/home/getting-started/upload-files.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.