Volumes - Anchor Browser Docs

Create Volume

POST /v1/volumes — createVolume

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.createVolume({
  body: {
    name: 'customer-reports'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.create_volume(
    name="customer-reports",
)
print(result)

List Volumes

GET /v1/volumes — listVolumes

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.listVolumes();
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.list_volumes()
print(result)

Get Volume By Name

GET /v1/volumes/by-name/{name} — getVolumeByName

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.getVolumeByName({
  path: {
    name: 'your-name'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.get_volume_by_name(
    "your-name",
)
print(result)

Get Volume

GET /v1/volumes/{volume_id} — getVolume

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.getVolume({
  path: {
    volume_id: 'your-volume-id'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.get_volume(
    "your-volume-id",
)
print(result)

Delete Volume

DELETE /v1/volumes/{volume_id} — deleteVolume

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.deleteVolume({
  path: {
    volume_id: 'your-volume-id'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.delete_volume(
    "your-volume-id",
)
print(result)

List Files

GET /v1/volumes/{volume_id}/files — listFiles

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.listFiles({
  path: {
    volume_id: 'your-volume-id'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.list_files(
    "your-volume-id",
)
print(result)

Upload File

POST /v1/volumes/{volume_id}/files — uploadFile

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.uploadFile({
  path: {
    volume_id: 'your-volume-id'
  },
  body: {
    file: new File(['file content'], 'file.txt')
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.upload_file(
    "your-volume-id",
    file=("file.txt", b"file content"),
)
print(result)

Delete Files

DELETE /v1/volumes/{volume_id}/files — deleteFiles

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.deleteFiles({
  path: {
    volume_id: 'your-volume-id'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.delete_files(
    "your-volume-id",
)
print(result)

Create Upload URL

POST /v1/volumes/{volume_id}/files/upload-url — createUploadUrl

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.createUploadUrl({
  path: {
    volume_id: 'your-volume-id'
  },
  body: {
    path: 'inputs/dataset.csv'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.create_upload_url(
    "your-volume-id",
    path="inputs/dataset.csv",
)
print(result)

Get File Info

GET /v1/volumes/{volume_id}/files/stat — getFileInfo

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.getFileInfo({
  path: {
    volume_id: 'your-volume-id'
  },
  query: {
    path: 'downloads/report.pdf'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.get_file_info(
    "your-volume-id",
    path="downloads/report.pdf",
)
print(result)

Download File

GET /v1/volumes/{volume_id}/files/download — getDownloadUrl

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.getDownloadUrl({
  path: {
    volume_id: 'your-volume-id'
  },
  query: {
    path: 'downloads/report.pdf'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.get_download_url(
    "your-volume-id",
    path="downloads/report.pdf",
)
print(result)

List All Paths

GET /v1/volumes/{volume_id}/paths — listPaths

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.listPaths({
  path: {
    volume_id: 'your-volume-id'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.list_paths(
    "your-volume-id",
)
print(result)

Create Directory

POST /v1/volumes/{volume_id}/directories — createDirectory

import { client, Volumes } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await Volumes.createDirectory({
  path: {
    volume_id: 'your-volume-id'
  },
  body: {
    path: 'reports/2026'
  }
});
console.log(result);

from anchorbrowser import Anchorbrowser

# ANCHORBROWSER_API_KEY is read from the environment by default;
# set it explicitly with Anchorbrowser(api_key="your-api-key")
client = Anchorbrowser()

result = client.volumes.create_directory(
    "your-volume-id",
    path="reports/2026",
)
print(result)

​Create Volume

​List Volumes

​Get Volume By Name

​Get Volume

​Delete Volume

​List Files

​Upload File

​Delete Files

​Create Upload URL

​Get File Info

​Download File

​List All Paths

​Create Directory