Anchor Browser

App · 20 actions

Start cloud browser sessions, capture pages, and manage profiles and volumes.

Actions

ActionWhat it does
Create page PDFCreate page PDF in Anchor Browser.
Create volumeCreate volume in Anchor Browser.
Delete volumeDelete volume in Anchor Browser.
End sessionEnd session in Anchor Browser.
Get applicationRetrieve application from Anchor Browser.
Get billing infoRetrieve billing info from Anchor Browser.
Get profileRetrieve profile from Anchor Browser.
Get sessionRetrieve session from Anchor Browser.
Get session historyRetrieve session history from Anchor Browser.
Get session tagsRetrieve session tags from Anchor Browser.
Get volumeRetrieve volume from Anchor Browser.
List applicationsRetrieve a page of applications from Anchor Browser.
List profilesRetrieve a page of profiles from Anchor Browser.
List session downloadsRetrieve a page of session downloads from Anchor Browser.
List session pagesRetrieve a page of session pages from Anchor Browser.
List session recordingsRetrieve a page of session recordings from Anchor Browser.
List sessionsRetrieve a page of sessions from Anchor Browser.
List volumesRetrieve a page of volumes from Anchor Browser.
Start sessionStart session in Anchor Browser.
Take screenshotTake screenshot in Anchor Browser.

Create page PDF

Create page PDF in Anchor Browser.

Inputs

Sessionsession_idtext
Optional browser session ID. If omitted, `url` in the request body is required.
URLurltextRequired
The URL of the page to print to PDF.
Landscapelandscapetrue/false
Paper orientation. Defaults to false.
Display header footerdisplay_header_footertrue/false
Display header and footer. Defaults to false.
Print backgroundprint_backgroundtrue/false
Print background graphics. Defaults to false.
Scalescalenumber
Scale of the webpage rendering. Defaults to 1.From 0.1 to 2.
Paper widthpaper_widthnumber
Paper width in inches. Defaults to 8.5.
Paper heightpaper_heightnumber
Paper height in inches. Defaults to 11.
Margin topmargin_topnumber
Top margin in inches. Defaults to ~0.4.At least 0.
Margin bottommargin_bottomnumber
Bottom margin in inches. Defaults to ~0.4.At least 0.
Margin leftmargin_leftnumber
Left margin in inches. Defaults to ~0.4.At least 0.
Margin rightmargin_rightnumber
Right margin in inches. Defaults to ~0.4.At least 0.
Page rangespage_rangestext
Page ranges to print, e.g. '1-5, 8, 11-13'. Defaults to all pages.
Header templateheader_templatetext
HTML template for the print header.
Footer templatefooter_templatetext
HTML template for the print footer.
Prefer csspage sizeprefer_csspage_sizetrue/false
Prefer page size as defined by CSS. Defaults to false.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Create volume

Create volume in Anchor Browser.

Inputs

NamenametextRequired
Volume name, unique within your team. Letters, numbers, `_` and `-`, up to 64 characters.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "deleted_at": "example",
      "error_reason": "example",
      "id": "example",
      "last_used_at": "example",
      "name": "example",
      "state": "creating",
      "updated_at": "example"
    }
  }
}

Delete volume

Delete volume in Anchor Browser.

Inputs

Volumevolume_idtextRequired
Volume id.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "status": "deleting"
    }
  }
}

End session

End session in Anchor Browser.

Inputs

Sessionsession_idtextRequired
The ID of the browser session to end.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "status": "example"
    }
  }
}

Get application

Retrieve application from Anchor Browser.

Inputs

Applicationapplication_idtextRequired
The ID of the application to retrieve.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "auth_methods": [],
    "created_at": "example",
    "description": "example",
    "id": "example",
    "identity_count": 1,
    "name": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Get billing info

Retrieve billing info from Anchor Browser.

Inputs

From datefrom_datedate and time
Start of the usage window (ISO 8601 format, UTC). Passing any of `from_date`, `to_date`, or `granularity` adds a `usage` block to the response. Defaults to 30 days ago.
To dateto_datedate and time
End of the usage window (ISO 8601 format, UTC). Defaults to now.
Granularitygranularitytext
Time granularity for the usage time series.One of: hour, day, week, month.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "billing_period": "example",
      "cost_limit": 1.0,
      "credits": 1.0,
      "credits_used": 1.0,
      "gifts_balance": 1.0,
      "included_credits": 1.0,
      "max_concurrent_browsers": 1.0,
      "tier": "example"
    },
    "usage": {
      "data": [],
      "from_date": "example",
      "granularity": "hour",
      "to_date": "example",
      "total_credits_used": 1.0
    }
  }
}

Get profile

Retrieve profile from Anchor Browser.

Inputs

Profile nameprofile_nametextRequired
The name of the profile to retrieve.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "description": "example",
      "name": "example",
      "session_id": "example",
      "source": "session",
      "status": "example"
    }
  }
}

Get session

Retrieve session from Anchor Browser.

Inputs

Sessionsession_idtextRequired
The ID of the session to retrieve.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "configuration": {},
      "created_at": "example",
      "credits_used": 1.0,
      "duration": 1,
      "proxy_bytes": 1,
      "session_id": "example",
      "status": "example",
      "steps": 1,
      "tags": [],
      "team_id": "example",
      "tokens": {}
    }
  }
}

Get session history

Retrieve session history from Anchor Browser.

Inputs

From datefrom_datedate and time
Start date for filtering (ISO 8601 format).
To dateto_datedate and time
End date for filtering (ISO 8601 format).
Granularitygranularitytext
Time granularity for aggregation.One of: hour, day, week, month.
Metricsmetricstext
Metrics to include in the response.
Pagepagenumber
Page number for pagination.At least 1.
Limitlimitnumber
Number of records per page.From 1 to 1000.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "current_page": 1,
      "has_next": false,
      "has_prev": false,
      "total_pages": 1,
      "total_records": 1
    },
    "summary": {
      "total_ai_steps": 1.0,
      "total_credits_used": 1.0,
      "total_network_bytes_total": 1.0,
      "total_proxy_bytes": 1.0,
      "total_screenshots": 1.0,
      "total_session_hours": 1.0,
      "total_sessions": 1.0
    }
  }
}

Get session tags

Retrieve session tags from Anchor Browser.

Inputs

Sessionsession_idtextRequired
The ID of the session to retrieve tags for.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "tags": []
  }
}

Get volume

Retrieve volume from Anchor Browser.

Inputs

Volumevolume_idtextRequired
Volume id.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "deleted_at": "example",
      "error_reason": "example",
      "id": "example",
      "last_used_at": "example",
      "name": "example",
      "state": "creating",
      "updated_at": "example"
    }
  }
}

List applications

Retrieve a page of applications from Anchor Browser.

Inputs

Searchsearchtext
Search query to filter applications by name.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "applications": []
  }
}

List profiles

Retrieve a page of profiles from Anchor Browser.

Inputs

None.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}

List session downloads

Retrieve a page of session downloads from Anchor Browser.

Inputs

Sessionsession_idtextRequired
The unique identifier of the browser session to retrieve downloads for.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}

List session pages

Retrieve a page of session pages from Anchor Browser.

Inputs

Sessionsession_idtextRequired
The ID of the session to retrieve pages for.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "count": 1.0,
      "items": []
    }
  }
}

List session recordings

Retrieve a page of session recordings from Anchor Browser.

Inputs

Sessionsession_idtextRequired
The ID of the browser session to retrieve recordings for.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}

List sessions

Retrieve a page of sessions from Anchor Browser.

Inputs

Pagepagenumber
Page number to fetch.At least 1.
Limitlimitnumber
Number of sessions per page. Supported values are 10, 20, and 50.One of: 10, 20, 50.
Sort bysort_bytext
Sort field. Common values are `created_at`, `session_id`, `used_credits`,.
Sort ordersort_ordertext
Sort direction.One of: asc, desc.
Searchsearchtext
Comma-separated tag search terms (partial, case-insensitive).
Statusstatustext
Exact session status filter.
Tagstagstext
Comma-separated tag list. Session must include all provided tags.
Domainsdomainstext
Comma-separated domain list. Session must include all provided domains.
Created fromcreated_fromdate and time
Include sessions created at or after this timestamp (ISO 8601).
Created tocreated_todate and time
Include sessions created at or before this timestamp (ISO 8601).
Batch IDbatch_idtext
Filter by batch identifier.
Task initiatedtask_initiatedtrue/false
Filter by whether the session was task-initiated.
Profile nameprofile_nametext
Case-insensitive partial match on browser profile name.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "page": 1.0,
      "sessions": [],
      "total": 1.0,
      "total_pages": 1.0
    }
  }
}

List volumes

Retrieve a page of volumes from Anchor Browser.

Inputs

Include deletedinclude_deletedtext
Include deleted volumes. Defaults to `false`.One of: true, false.
Statestatetext
Only return volumes in this state.One of: creating, ready, deleting, deleted, error.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}

Start session

Start session in Anchor Browser.

Inputs

Initial URLinitial_urltext
The URL to navigate to when the browser session starts. If not provided, the browser will load an empty page.
Tagstagslist
Custom labels to categorize and identify browser sessions. Useful for filtering, organizing, and tracking sessions across your workflows.
Record sessionrecord_sessiontrue/false
Enable or disable video recording of the browser session. Defaults to `true`.
Max durationmax_durationnumber
Maximum time (in minutes) the session can run before automatically terminating. Defaults to `20`. Set to `-1` to disable this limit.
Headlessheadlesstrue/false
Whether browser should be headless or headful. Defaults to `false`.
Widthwidthnumber
Width of the viewport in pixels. Defaults to `1440`.
Heightheightnumber
Height of the viewport in pixels. Defaults to `900`.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "data": {
      "cdp_url": "example",
      "id": "example",
      "live_view_read_only_url": "example",
      "live_view_url": "example"
    }
  }
}

Take screenshot

Take screenshot in Anchor Browser.

Inputs

Sessionsession_idtext
An optional browser session identifier to reference an existing running browser sessions. When passed, the tool will be executed on the provided browser session.
URLurltext
The URL of the webpage to capture.
Widthwidthnumber
The width of the browser viewport in pixels.
Heightheightnumber
The height of the browser viewport in pixels.
Image qualityimage_qualitynumber
Quality of the output image, on the range 1-100. 100 will not perform any compression.
Waitwaitnumber
Duration in milliseconds to wait after page has loaded, mainly used for sites with JS animations.
Scroll all contentscroll_all_contenttrue/false
If true, scrolls the page and captures all visible content.
Capture full heightcapture_full_heighttrue/false
If true, captures the entire height of the page, ignoring the viewport height.

Outputs

dataobject
The result returned by Anchor Browser.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

On this page