Anchor Browser Volumes API

The Volumes API from Anchor Browser — 3 operation(s) for volumes.

GitHub OpenAPI

Operations 5

POST /v1/volumes Create Volume #
GET /v1/volumes List Volumes #
GET /v1/volumes/by-name/{name} Get Volume By Name #
GET /v1/volumes/{volume_id} Get Volume #
DELETE /v1/volumes/{volume_id} Delete Volume #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/anchorbrowser:anchorbrowser-volumes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

anchorbrowser-volumes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AnchorBrowser Volumes API
  version: 1.0.0
  description: 'Anchor Browser (anchorbrowser.io) provides cloud browsers built

    for AI agents and automation. Use this API to launch and control browser sessions, run

    natural-language web tasks, authenticate into third-party web apps with managed identities,

    and capture recordings — reliably and at scale, without operating browser infrastructure

    yourself.


    ## Core resources

    - **Sessions** (`/v1/sessions`): launch configurable cloud browsers — residential proxies,

    stealth browsing, captcha solving, profiles, extensions, recording — and connect over CDP

    with Playwright, Puppeteer, or any CDP client.

    - **AI tools** (`/v1/tools/perform-web-task`): state a goal in natural language and the

    built-in agent completes it inside the browser. Related tools fetch webpages, take

    screenshots, render PDFs, and execute code in a session.

    - **Tasks** (`/v1/task`): create, version, deploy, and monitor repeatable browser

    automations built to run reliably in production.

    - **Applications and identities** (`/v1/applications`, `/v1/identities`): managed

    authentication into third-party web apps — including multi-step logins and TOTP-based

    2FA — so agents can act on behalf of users.

    - **Profiles** (`/v1/profiles`): persist cookies and login state across sessions.

    - **OS-level control** (`/v1/sessions/{sessionId}/mouse`, `/keyboard`, `/clipboard`):

    raw input for flows that resist DOM automation.

    - Plus batch sessions for running browser fleets in parallel, session recordings, webhooks,

    events, extensions, client certificates, and billing usage.


    ## Authentication

    Pass an API key in the `anchor-api-key` header on every request. Create keys at

    app.anchorbrowser.io under API Access. AI agents that have

    no key yet can obtain one autonomously through the unauthenticated

    agent-access flow

    (`POST /v1/agent-access`).


    ## For AI agents and LLMs

    - Docs: docs.anchorbrowser.io, with a machine-readable

    index at /llms.txt and the full corpus at

    /llms-full.txt.

    - MCP server for hosted browser control: `https://api.anchorbrowser.io/mcp`.

    - Official SDKs: `anchorbrowser` on npm and

    PyPI.


    `DELETE` operations terminate sessions or permanently remove resources (profiles,

    identities, extensions); `GET` operations are safe and read-only.'
servers:
- url: https://api.anchorbrowser.io
  description: API server
tags:
- name: Volumes
paths:
  /v1/volumes:
    post:
      summary: Create Volume
      description: Create a persistent volume for your team. The volume is usually `ready` immediately; if the response says `creating`, poll `GET /v1/volumes/{volume_id}` until it is. Each team can have up to 10 volumes.
      security:
      - api_key_header: []
      tags:
      - Volumes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: Volume name, unique within your team. Letters, numbers, `_` and `-`, up to 64 characters.
                  example: customer-reports
      responses:
        '200':
          description: Volume created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeResponse'
        '400':
          description: Invalid name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Volumes are not enabled for this team
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: A volume with this name already exists, or the team reached its volume limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postV1Volumes
      x-operation-id-source: derived
    get:
      summary: List Volumes
      description: List the volumes of your team.
      security:
      - api_key_header: []
      tags:
      - Volumes
      parameters:
      - name: include_deleted
        in: query
        required: false
        description: Include deleted volumes. Defaults to `false`.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: state
        in: query
        required: false
        description: Only return volumes in this state
        schema:
          type: string
          enum:
          - creating
          - ready
          - deleting
          - deleted
          - error
      responses:
        '200':
          description: Volumes retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeListResponse'
      operationId: getV1Volumes
      x-operation-id-source: derived
  /v1/volumes/by-name/{name}:
    get:
      summary: Get Volume By Name
      description: Get a volume by its name.
      security:
      - api_key_header: []
      tags:
      - Volumes
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Volume details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeResponse'
        '404':
          description: Volume not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getV1VolumesByNameByName
      x-operation-id-source: derived
  /v1/volumes/{volume_id}:
    get:
      summary: Get Volume
      description: Get a volume by its ID. Deleted volumes return `404`; use `GET /v1/volumes?include_deleted=true` to see them.
      security:
      - api_key_header: []
      tags:
      - Volumes
      parameters:
      - name: volume_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Volume details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeResponse'
        '404':
          description: Volume not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getV1VolumesByVolumeId
      x-operation-id-source: derived
    delete:
      summary: Delete Volume
      description: Delete a volume and every file in it. Refused while a running session has the volume mounted; end those sessions first.
      security:
      - api_key_header: []
      tags:
      - Volumes
      parameters:
      - name: volume_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Deletion finished (`deleted`) or still in progress (`deleting`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                        - deleting
                        - deleted
        '404':
          description: Volume not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: The volume is mounted by a running session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: deleteV1VolumesByVolumeId
      x-operation-id-source: derived
components:
  schemas:
    VolumeResponseSchema:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the volume. Use it in `browser.volume.id` when creating a session.
        name:
          type: string
          description: Volume name, unique within your team
        state:
          type: string
          enum:
          - creating
          - ready
          - deleting
          - deleted
          - error
          description: Lifecycle state. Only `ready` volumes can be mounted or written to.
        error_reason:
          type: string
          nullable: true
          description: Why the volume entered the `error` state, if it did
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        last_used_at:
          type: string
          format: date-time
          nullable: true
          description: Last time the volume was mounted into a session
        deleted_at:
          type: string
          format: date-time
          nullable: true
    VolumeListResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            count:
              type: integer
              description: Number of volumes returned
            items:
              type: array
              items:
                $ref: '#/components/schemas/VolumeResponseSchema'
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
    VolumeResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/VolumeResponseSchema'
  securitySchemes:
    api_key_header:
      type: apiKey
      in: header
      name: anchor-api-key
      description: 'API key for your Anchor Browser account, sent as the `anchor-api-key` header on every

        request. Create one at [app.anchorbrowser.io](https://app.anchorbrowser.io) (API Access),

        or obtain one programmatically via the unauthenticated agent-access flow

        (`POST /v1/agent-access`).

        '