# Anchor Browser

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/anchor-browser

## Actions

### Create page PDF

Create page PDF in Anchor Browser.

**Inputs**

- Session (`session_id`, text): Optional browser session ID. If omitted, `url` in the request body is required.
- URL (`url`, text, required): The URL of the page to print to PDF.
- Landscape (`landscape`, true/false): Paper orientation. Defaults to false.
- Display header footer (`display_header_footer`, true/false): Display header and footer. Defaults to false.
- Print background (`print_background`, true/false): Print background graphics. Defaults to false.
- Scale (`scale`, number): Scale of the webpage rendering. Defaults to 1. From 0.1 to 2.
- Paper width (`paper_width`, number): Paper width in inches. Defaults to 8.5.
- Paper height (`paper_height`, number): Paper height in inches. Defaults to 11.
- Margin top (`margin_top`, number): Top margin in inches. Defaults to ~0.4. At least 0.
- Margin bottom (`margin_bottom`, number): Bottom margin in inches. Defaults to ~0.4. At least 0.
- Margin left (`margin_left`, number): Left margin in inches. Defaults to ~0.4. At least 0.
- Margin right (`margin_right`, number): Right margin in inches. Defaults to ~0.4. At least 0.
- Page ranges (`page_ranges`, text): Page ranges to print, e.g. '1-5, 8, 11-13'. Defaults to all pages.
- Header template (`header_template`, text): HTML template for the print header.
- Footer template (`footer_template`, text): HTML template for the print footer.
- Prefer csspage size (`prefer_csspage_size`, true/false): Prefer page size as defined by CSS. Defaults to false.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Create volume

Create volume in Anchor Browser.

**Inputs**

- Name (`name`, text, required): Volume name, unique within your team. Letters, numbers, `_` and `-`, up to 64 characters.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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**

- Volume (`volume_id`, text, required): Volume id.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "status": "deleting"
    }
  }
}
```

### End session

End session in Anchor Browser.

**Inputs**

- Session (`session_id`, text, required): The ID of the browser session to end.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "status": "example"
    }
  }
}
```

### Get application

Retrieve application from Anchor Browser.

**Inputs**

- Application (`application_id`, text, required): The ID of the application to retrieve.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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 date (`from_date`, date 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 date (`to_date`, date and time): End of the usage window (ISO 8601 format, UTC). Defaults to now.
- Granularity (`granularity`, text): Time granularity for the usage time series. One of: `hour`, `day`, `week`, `month`.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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 name (`profile_name`, text, required): The name of the profile to retrieve.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "created_at": "example",
      "description": "example",
      "name": "example",
      "session_id": "example",
      "source": "session",
      "status": "example"
    }
  }
}
```

### Get session

Retrieve session from Anchor Browser.

**Inputs**

- Session (`session_id`, text, required): The ID of the session to retrieve.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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 date (`from_date`, date and time): Start date for filtering (ISO 8601 format).
- To date (`to_date`, date and time): End date for filtering (ISO 8601 format).
- Granularity (`granularity`, text): Time granularity for aggregation. One of: `hour`, `day`, `week`, `month`.
- Metrics (`metrics`, text): Metrics to include in the response.
- Page (`page`, number): Page number for pagination. At least 1.
- Limit (`limit`, number): Number of records per page. From 1 to 1000.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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**

- Session (`session_id`, text, required): The ID of the session to retrieve tags for.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "tags": []
  }
}
```

### Get volume

Retrieve volume from Anchor Browser.

**Inputs**

- Volume (`volume_id`, text, required): Volume id.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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**

- Search (`search`, text): Search query to filter applications by name.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "applications": []
  }
}
```

### List profiles

Retrieve a page of profiles from Anchor Browser.

**Inputs**: None.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}
```

### List session downloads

Retrieve a page of session downloads from Anchor Browser.

**Inputs**

- Session (`session_id`, text, required): The unique identifier of the browser session to retrieve downloads for.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}
```

### List session pages

Retrieve a page of session pages from Anchor Browser.

**Inputs**

- Session (`session_id`, text, required): The ID of the session to retrieve pages for.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "count": 1.0,
      "items": []
    }
  }
}
```

### List session recordings

Retrieve a page of session recordings from Anchor Browser.

**Inputs**

- Session (`session_id`, text, required): The ID of the browser session to retrieve recordings for.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}
```

### List sessions

Retrieve a page of sessions from Anchor Browser.

**Inputs**

- Page (`page`, number): Page number to fetch. At least 1.
- Limit (`limit`, number): Number of sessions per page. Supported values are 10, 20, and 50. One of: `10`, `20`, `50`.
- Sort by (`sort_by`, text): Sort field. Common values are `created_at`, `session_id`, `used_credits`,.
- Sort order (`sort_order`, text): Sort direction. One of: `asc`, `desc`.
- Search (`search`, text): Comma-separated tag search terms (partial, case-insensitive).
- Status (`status`, text): Exact session status filter.
- Tags (`tags`, text): Comma-separated tag list. Session must include all provided tags.
- Domains (`domains`, text): Comma-separated domain list. Session must include all provided domains.
- Created from (`created_from`, date and time): Include sessions created at or after this timestamp (ISO 8601).
- Created to (`created_to`, date and time): Include sessions created at or before this timestamp (ISO 8601).
- Batch ID (`batch_id`, text): Filter by batch identifier.
- Task initiated (`task_initiated`, true/false): Filter by whether the session was task-initiated.
- Profile name (`profile_name`, text): Case-insensitive partial match on browser profile name.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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 deleted (`include_deleted`, text): Include deleted volumes. Defaults to `false`. One of: `true`, `false`.
- State (`state`, text): Only return volumes in this state. One of: `creating`, `ready`, `deleting`, `deleted`, `error`.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "data": {
      "count": 1,
      "items": []
    }
  }
}
```

### Start session

Start session in Anchor Browser.

**Inputs**

- Initial URL (`initial_url`, text): The URL to navigate to when the browser session starts. If not provided, the browser will load an empty page.
- Tags (`tags`, list): Custom labels to categorize and identify browser sessions. Useful for filtering, organizing, and tracking sessions across your workflows.
- Record session (`record_session`, true/false): Enable or disable video recording of the browser session. Defaults to `true`.
- Max duration (`max_duration`, number): Maximum time (in minutes) the session can run before automatically terminating. Defaults to `20`. Set to `-1` to disable this limit.
- Headless (`headless`, true/false): Whether browser should be headless or headful. Defaults to `false`.
- Width (`width`, number): Width of the viewport in pixels. Defaults to `1440`.
- Height (`height`, number): Height of the viewport in pixels. Defaults to `900`.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "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**

- Session (`session_id`, text): An optional browser session identifier to reference an existing running browser sessions. When passed, the tool will be executed on the provided browser session.
- URL (`url`, text): The URL of the webpage to capture.
- Width (`width`, number): The width of the browser viewport in pixels.
- Height (`height`, number): The height of the browser viewport in pixels.
- Image quality (`image_quality`, number): Quality of the output image, on the range 1-100. 100 will not perform any compression.
- Wait (`wait`, number): Duration in milliseconds to wait after page has loaded, mainly used for sites with JS animations.
- Scroll all content (`scroll_all_content`, true/false): If true, scrolls the page and captures all visible content.
- Capture full height (`capture_full_height`, true/false): If true, captures the entire height of the page, ignoring the viewport height.

**Outputs**

- `data` (object): The result returned by Anchor Browser.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```
