Sessions - Anchor Browser Docs

List Sessions History Page

GET /v1/sessions — listSessions

import { client, Sessions } 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 Sessions.listSessions();
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.sessions.list_sessions()
print(result)

Start Browser Session

POST /v1/sessions — createSession

import { client, Sessions } 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 Sessions.createSession();
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.sessions.create_session()
print(result)

Start Browser Session (async)

POST /v1/sessions/async — createSessionAsync

import { client, Sessions } 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 Sessions.createSessionAsync();
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.sessions.create_session_async()
print(result)

Async Session Status

GET /v1/sessions/async/{request_id}/status — getAsyncSessionStatus

import { client, Sessions } 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 Sessions.getAsyncSessionStatus({
  path: {
    request_id: 'your-request-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.sessions.get_async_session_status(
    "your-request-id",
)
print(result)

End All Sessions

DELETE /v1/sessions/all — deleteAllSessions

import { client, Sessions } 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 Sessions.deleteAllSessions();
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.sessions.delete_all_sessions()
print(result)

List All Sessions Status

GET /v1/sessions/all/status — getAllSessionsStatus

import { client, Sessions } 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 Sessions.getAllSessionsStatus();
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.sessions.get_all_sessions_status()
print(result)

Get Sessions History

GET /v1/sessions/history — getSessionsHistory

import { client, Sessions } 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 Sessions.getSessionsHistory();
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.sessions.get_sessions_history()
print(result)

Get Browser Session

GET /v1/sessions/{session_id} — getSession

import { client, Sessions } 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 Sessions.getSession({
  path: {
    session_id: 'your-session-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.sessions.get_session(
    "your-session-id",
)
print(result)

End Browser Session

DELETE /v1/sessions/{session_id} — deleteSession

import { client, Sessions } 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 Sessions.deleteSession({
  path: {
    session_id: 'your-session-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.sessions.delete_session(
    "your-session-id",
)
print(result)

Get Session Tags

GET /v1/sessions/{session_id}/tags — getSessionTags

import { client, Sessions } 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 Sessions.getSessionTags({
  path: {
    session_id: 'your-session-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.sessions.get_session_tags(
    "your-session-id",
)
print(result)

Put Session Tags

PUT /v1/sessions/{session_id}/tags — putSessionTags

import { client, Sessions } 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 Sessions.putSessionTags({
  path: {
    session_id: 'your-session-id'
  },
  body: {
    tags: ['production', 'scraping', 'customer-123']
  }
});
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.sessions.put_session_tags(
    "your-session-id",
    tags=["production", "scraping", "customer-123"],
)
print(result)

Delete Session Tags

DELETE /v1/sessions/{session_id}/tags — deleteSessionTags

import { client, Sessions } 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 Sessions.deleteSessionTags({
  path: {
    session_id: 'your-session-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.sessions.delete_session_tags(
    "your-session-id",
)
print(result)

Get Browser Session Pages

GET /v1/sessions/{session_id}/pages — getSessionPages

import { client, Sessions } 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 Sessions.getSessionPages({
  path: {
    session_id: 'your-session-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.sessions.get_session_pages(
    "your-session-id",
)
print(result)

Upload Files

POST /v1/sessions/{sessionId}/uploads — uploadFile

import { client, Sessions } 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 Sessions.uploadFile({
  path: {
    sessionId: 'your-sessionId'
  },
  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.sessions.upload_file(
    "your-session-id",
    file=("file.txt", b"file content"),
)
print(result)

List Session Downloads

GET /v1/sessions/{session_id}/downloads — getSessionDownloads

import { client, Sessions } 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 Sessions.getSessionDownloads({
  path: {
    session_id: 'your-session-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.sessions.get_session_downloads(
    "your-session-id",
)
print(result)

Take Screenshot

GET /v1/sessions/{sessionId}/screenshot — getSessionScreenshot

import { client, Sessions } 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 Sessions.getSessionScreenshot({
  path: {
    sessionId: 'your-sessionId'
  }
});
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.sessions.get_session_screenshot(
    "your-session-id",
)
print(result)

Mouse Click

POST /v1/sessions/{sessionId}/mouse/click — mouseClick

import { client, Sessions } 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 Sessions.mouseClick({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {}
});
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.sessions.mouse_click(
    "your-session-id",
)
print(result)

Mouse Double Click

POST /v1/sessions/{sessionId}/mouse/doubleClick — mouseDoubleClick

import { client, Sessions } 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 Sessions.mouseDoubleClick({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    x: 1,
    y: 1
  }
});
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.sessions.mouse_double_click(
    "your-session-id",
    x=1,
    y=1,
)
print(result)

Mouse Down

POST /v1/sessions/{sessionId}/mouse/down — mouseDown

import { client, Sessions } 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 Sessions.mouseDown({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    x: 1,
    y: 1
  }
});
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.sessions.mouse_down(
    "your-session-id",
    x=1,
    y=1,
)
print(result)

Mouse Up

POST /v1/sessions/{sessionId}/mouse/up — mouseUp

import { client, Sessions } 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 Sessions.mouseUp({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    x: 1,
    y: 1
  }
});
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.sessions.mouse_up(
    "your-session-id",
    x=1,
    y=1,
)
print(result)

Mouse Move

POST /v1/sessions/{sessionId}/mouse/move — mouseMove

import { client, Sessions } 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 Sessions.mouseMove({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    x: 1,
    y: 1
  }
});
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.sessions.mouse_move(
    "your-session-id",
    x=1,
    y=1,
)
print(result)

Drag and Drop

POST /v1/sessions/{sessionId}/drag-and-drop — dragAndDrop

import { client, Sessions } 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 Sessions.dragAndDrop({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    startX: 1,
    startY: 1,
    endX: 1,
    endY: 1
  }
});
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.sessions.drag_and_drop(
    "your-session-id",
    start_x=1,
    start_y=1,
    end_x=1,
    end_y=1,
)
print(result)

Scroll

POST /v1/sessions/{sessionId}/scroll — scroll

import { client, Sessions } 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 Sessions.scroll({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    x: 1,
    y: 1,
    deltaY: 1
  }
});
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.sessions.scroll(
    "your-session-id",
    x=1,
    y=1,
    delta_y=1,
)
print(result)

Type Text

POST /v1/sessions/{sessionId}/keyboard/type — keyboardType

import { client, Sessions } 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 Sessions.keyboardType({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    text: 'string'
  }
});
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.sessions.keyboard_type(
    "your-session-id",
    text="string",
)
print(result)

Keyboard Shortcut

POST /v1/sessions/{sessionId}/keyboard/shortcut — keyboardShortcut

import { client, Sessions } 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 Sessions.keyboardShortcut({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    keys: ['string']
  }
});
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.sessions.keyboard_shortcut(
    "your-session-id",
    keys=["string"],
)
print(result)

Get Clipboard Content

GET /v1/sessions/{sessionId}/clipboard — getClipboard

import { client, Sessions } 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 Sessions.getClipboard({
  path: {
    sessionId: 'your-sessionId'
  }
});
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.sessions.get_clipboard(
    "your-session-id",
)
print(result)

Set Clipboard Content

POST /v1/sessions/{sessionId}/clipboard — setClipboard

import { client, Sessions } 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 Sessions.setClipboard({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    text: 'string'
  }
});
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.sessions.set_clipboard(
    "your-session-id",
    text="string",
)
print(result)

Copy Selected Text

POST /v1/sessions/{sessionId}/copy — copy

import { client, Sessions } 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 Sessions.copy({
  path: {
    sessionId: 'your-sessionId'
  }
});
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.sessions.copy(
    "your-session-id",
)
print(result)

Paste Text

POST /v1/sessions/{sessionId}/paste — paste

import { client, Sessions } 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 Sessions.paste({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    text: 'string'
  }
});
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.sessions.paste(
    "your-session-id",
    text="string",
)
print(result)

Navigate to URL

POST /v1/sessions/{sessionId}/goto — goto

import { client, Sessions } 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 Sessions.goto({
  path: {
    sessionId: 'your-sessionId'
  },
  body: {
    url: 'string'
  }
});
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.sessions.goto(
    "your-session-id",
    url="string",
)
print(result)

​List Sessions History Page

​Start Browser Session

​Start Browser Session (async)

​Async Session Status

​End All Sessions

​List All Sessions Status

​Get Sessions History

​Get Browser Session

​End Browser Session

​Get Session Tags

​Put Session Tags

​Delete Session Tags

​Get Browser Session Pages

​Upload Files

​List Session Downloads

​Take Screenshot

​Mouse Click

​Mouse Double Click

​Mouse Down

​Mouse Up

​Mouse Move

​Drag and Drop

​Scroll

​Type Text

​Keyboard Shortcut

​Get Clipboard Content

​Set Clipboard Content

​Copy Selected Text

​Paste Text

​Navigate to URL