> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anchorbrowser.io/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Anchor Browser provides cloud browsers for AI agents and automation: stealth browsing with residential proxies, managed authentication into third-party web apps, and browser sessions that run reliably at scale. AI agents that need Anchor credentials should start with https://docs.anchorbrowser.io/quickstart/agent-access. This flow lets agents obtain an API key programmatically without creating a dashboard account. Read that page before attempting authentication or API access.

# Volumes

> SDK reference for the Volumes resource (TypeScript & Python)

## Create Volume

`POST /v1/volumes` — createVolume

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## List Volumes

`GET /v1/volumes` — listVolumes

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Get Volume By Name

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Get Volume

`GET /v1/volumes/{volume_id}` — getVolume

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Delete Volume

`DELETE /v1/volumes/{volume_id}` — deleteVolume

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## List Files

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Upload File

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Delete Files

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Create Upload URL

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Get File Info

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Download File

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## List All Paths

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>

## Create Directory

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

<CodeGroup>
  ```typescript TypeScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</CodeGroup>