reference/sdk/volume.md

---
title: Volume
version: EN
---

### read_volume_file
```python
vessl.read_volume_file(
   volume_id: int, path: str
)
```
Read a file in the volume.

**Args**
* `volume_id` (int) : Volume ID.
* `path` (str) : Path within the volume.

**Example**
```python
vessl.read_volume_file(
    volume_id=123456,
    path="train.csv",
)
```

----

## list_volume_files
```python
vessl.list_volume_files(
   volume_id: int, need_download_url: bool = False, path: str = '',
   recursive: bool = False
)
```
List files in the volume.

**Args**
* `volume_id` (int) : Volume ID.
* `need_download_url` (bool) : True if you need a download URL, False
    otherwise. Defaults to False.
* `path` (str) : Path within the volume. Defaults to root.
* `recursive` (bool) : True if list files recursively, False otherwise.
    Defaults to False.

**Example**
```python
vessl.list_volume_files(
    volume_id=123456,
)
```

----

## create_volume_file
```python
vessl.create_volume_file(
   volume_id: int, is_dir: bool, path: str
)
```
Create file in the volume.

**Args**
* `volume_id` (int) : Volume ID.
* `is_dir` (bool) : True if a file is directory, False otherwise.
* `path` (str) : Path within the volume.

**Example**
```python
vessl.create_volume_file(
    volume_id=123456,
    is_dir=False,
    path="models"
)
```

----

## delete_volume_file
```python
vessl.delete_volume_file(
   volume_id: int, path: str
)
```
Delete file in the volume.

**Args**
* `volume_id` (int) : Volume ID.
* `path` (str) : Path within the volume.

**Example**
```python
vessl.delete_volume_file(
    volume_id=123456,
    path="model.pth",
)
```

----

## upload_volume_file
```python
vessl.upload_volume_file(
   volume_id: int, path: str
)
```
Upload file in the volume.

**Args**
* `volume_id` (int) : Volume ID.
* `path` (str) : Local file path to upload

**Example**
```python
vessl.upload_volume_file(
    volume_id=123456,
    path="model.pth",
)
```

----

## copy_volume_file
```python
vessl.copy_volume_file(
   source_volume_id: Optional[int], source_path: str,
   dest_volume_id: Optional[int], dest_path: str, quiet: bool = False
)
```
Copy file either from local to remote, remote to local, or remote to
remote.

**Args**
* `source_volume_id` (Optional[int]) : Source volume file id. If not
    specified, source is assumed to be local.
* `source_path` (str) : If source_volume_id is empty, local source path.
    Otherwise, remote source path.
* `dest_volume_id` (Optional[int]) : Destination volume file id. If not
    specified, destination is assumed to be local.
* `dest_path` (str) : If dest_volume_id is empty, local destination path.
    Otherwise, remote destination path.
* `quiet` (bool) : True if the muted output, False otherwise. Defaults to
    False.

**Example**
```python
vessl.copy_volume_file(
    source_volume_id=123456,
    source_path="model.pth",
    dest_volume_id=123457,
    dest_path="model.pth",
)
```