# Browshot API API

> Browshot API API on Apizie: 17 endpoints (Get information about your account, Requests thousands of screenshtos at once, Get the batch status, Get information about a browser, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/web-tools:browshot/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `web-tools:browshot`
- Category: Web Tools
- Status: byok
- Source: https://browshot.com/contact
- Page: https://zieapi.vercel.app/api/web-tools/browshot
- OpenAPI: https://zieapi.vercel.app/api/web-tools/browshot/openapi.json

Take screenshots of any website in real time

## Endpoints

### Get information about your account
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-account-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| details | integer | no | level of information returned |

### Requests thousands of screenshtos at once
`POST https://zieapi.vercel.app/v1/web-tools:browshot/create-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| hosting | string | no | hosting option - s3 or browshot |
| hosting_height | integer | no | maximum height of the thumbnail to host |
| hosting_width | integer | no | maximum height of the thumbnail to host |
| hosting_scale | number | no | scale of the thumbnail to host |
| hosting_bucket | string | no | S3 bucket to upload the screenshot or thumbnail (required for S3) |
| hosting_file | string | no | file name to use (for S3 only) |
| hosting_headers | string | no | list of headers to add to the S3 object (for S3 only) |
| body | object | yes | Form fields as a JSON object |

### Get the batch status
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-batch-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | batch ID |

### Get information about a browser
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-browser-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | browser ID |

### Get all browsers
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-browsers-info` (byok)

### Get information about an instance
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-instance-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | instance ID |

### Get all instances
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-instances-info` (byok)

### Request a screenshot
`GET https://zieapi.vercel.app/v1/web-tools:browshot/create-screenshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| url | string | yes | URL of the page to get a screenshot for |
| instance_id | integer | yes | instance ID to use |
| size | string | no | screenshot size - "screen" (default) or "page" |
| cache | integer | no | use a previous screenshot (same URL, same instance) if it was done within seconds. The default value is 24hours. Specify cache=0 if you… |
| delay | integer | no | number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0… |
| flash_delay | integer | no | number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster. |
| screen_width | integer | no | width of the browser window. For desktop browsers only. |
| screen_height | integer | no | height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px) |
| priority | integer | no | assign priority to the screenshot (for private instances only) |
| referer | string | no | use a custom referrer header - paid screenshots only |
| post_data | string | no | send a POST requests with post_data, useful for filling out forms - paid screenshots only |
| cookie | string | no | set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only |
| script | string | no | URL of javascript file to execute after the page load event |
| details | integer | no | level of information available with screenshot/info |
| html | integer | no | saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs *1 credit* per screenshot. |
| max_wait | integer | no | maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled) |
| headers | string | no | any custom HTTP headers. (Not supported with Internet Explorer) |
| shots | integer | no | take multiple screenshots of the same page. This costs 1 additional credit for every 2 additional screenshots. |
| shot_interval | integer | no | number of seconds between 2 screenshots |
| hosting | string | no | hosting option - s3 or browshot |
| hosting_height | integer | no | maximum height of the thumbnail to host |
| hosting_width | integer | no | maximum height of the thumbnail to host |
| hosting_scale | number | no | scale of the thumbnail to host |
| hosting_bucket | string | no | S3 bucket to upload the screenshot or thumbnail (required for S3) |
| hosting_file | string | no | file name to use (for S3 only) |
| hosting_headers | string | no | list of headers to add to the S3 object (for S3 only) |

### Delete screenshot data
`GET https://zieapi.vercel.app/v1/web-tools:browshot/delete-screenshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | screenshot ID |
| data | string | no | data to remove. You can specify multiple of them (separated by a ,): *image* (image files), *url* (url requested), *metadata* (time added,… |

### Host thumbnails on your own S3 account or on Browshot.
`GET https://zieapi.vercel.app/v1/web-tools:browshot/host-screenshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | screenshot ID |
| hosting | string | yes | hosting option: s3 or browshot |
| width | integer | no | width of the thumbnail |
| height | integer | no | height of the thumbnail |
| scale | number | no | scale of the thumbnail |
| bucket | string | no | S3 bucket to upload the screenshot or thumbnail - required with hosting=s3 |
| file | string | no | file name to use - optional, used with hosting=s3 |
| headers | string | no | HTTP headers to add to your S3 object - optional, used with hosting=s3 |

### Get the HTML code
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-html` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | screenshot ID |

### Query screenshot status
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-screenshot-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | screenshot ID received from /api/v1/screenshot/create |
| details | integer | no | level of details about the screenshot and the page |

### Get information about screenshots
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-multiple-screenshots-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | maximum number of screenshots' information to return |
| status | string | no | get list of screenshot in a given status (error, finished, in_process) |

### Request multiple screenshots
`GET https://zieapi.vercel.app/v1/web-tools:browshot/create-multiple-screenshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| url | string | yes | URL of the page to get a screenshot for. You can specify multiple url parameters (up to 10). |
| instance_id | integer | yes | instance ID to use. You can specify multiple instance_id parameters (up to 10). |
| size | string | no | screenshot size - "screen" (default) or "page" |
| cache | integer | no | use a previous screenshot (same URL, same instance) if it was done within seconds. The default value is 24hours. Specify cache=0 if you… |
| delay | integer | no | number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0… |
| flash_delay | integer | no | number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster. |
| screen_width | integer | no | width of the browser window. For desktop browsers only. |
| screen_height | integer | no | height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px) |
| priority | integer | no | assign priority to the screenshot (for private instances only) |
| referer | string | no | use a custom referrer header - paid screenshots only |
| post_data | string | no | send a POST requests with post_data, useful for filling out forms - paid screenshots only |
| cookie | string | no | set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only |
| script | string | no | URL of javascript file to execute after the page load event |
| details | integer | no | level of information available with screenshot/info |
| html | integer | no | saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs *1 credit* per screenshot. |
| max_wait | integer | no | maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled) |
| headers | string | no | any custom HTTP headers. (Not supported with Internet Explorer) |
| hosting | string | no | hosting option - s3 or browshot |
| hosting_height | integer | no | maximum height of the thumbnail to host |
| hosting_width | integer | no | maximum height of the thumbnail to host |
| hosting_scale | number | no | scale of the thumbnail to host |
| hosting_bucket | string | no | S3 bucket to upload the screenshot or thumbnail (required for S3) |
| hosting_file | string | no | file name to use (for S3 only) |
| hosting_headers | string | no | list of headers to add to the S3 object (for S3 only) |

### Search for screenshots
`GET https://zieapi.vercel.app/v1/web-tools:browshot/search-screenshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| url | string | yes | look for a string matching the URL requested |
| limit | integer | no | maximum number of screenshots' information to return |
| status | string | no | get list of screenshot in a given status (error, finished, in_process) |

### Share a screenshot
`GET https://zieapi.vercel.app/v1/web-tools:browshot/share-screenshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | screenshot ID |
| note | string | no | note to add on the sharing page |

### Retrieve a thumbnail image
`GET https://zieapi.vercel.app/v1/web-tools:browshot/get-thumbnail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | screenshot ID |
| width | integer | no | width of the thumbnail |
| height | integer | no | height of the thumbnail |
| scale | number | no | scale of the thumbnail |
| zoom | integer | no | zoom 1 to 100 percent |
| ratio | string | no | Use fit to keep the original page ration, and fill to get a thumbnail for the exact width and height. specified. If you provide both width… |
| left | integer | no | left edge of the area to be cropped |
| right | integer | no | right edge of the area to be cropped |
| top | integer | no | top edge of the area to be cropped |
| bottom | integer | no | bottom edge of the area to be cropped |
| format | string | no | image as PNG or JPEG |
| shot | integer | no | get the second or third screenshot if multiple screenshots were requested |
| quality | integer | no | JPEG quality factor (for JPEG thumbnails only) |

## Example
```
curl "https://zieapi.vercel.app/v1/web-tools:browshot/get-account-info" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Browshot API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/web-tools:browshot/get-account-info with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Browshot API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Browshot API itself also needs your own key from browshot.com.

### Can AI agents use the Browshot API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key web-tools:browshot.

### What is the status of the Browshot API API?
Needs your own provider key (bring your own key)