---
canonical_url: "https://docs.composio.dev/toolkits/screenshotbase"
markdown_url: "https://docs.composio.dev/toolkits/screenshotbase.md"
product: "platform"
version: null
last_updated: null
---

# Screenshotbase

Screenshotbase renders URLs, HTML, and Markdown as images, PDFs, rendered HTML, or Markdown and manages asynchronous render jobs.

- **Category:** images & design
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `SCREENSHOTBASE`
- **Version:** 00000000_00

## Tools

### Delete Render Job

**Slug:** `SCREENSHOTBASE_DELETE_JOB`

Cancel and delete one asynchronous render job and its stored result. Queued jobs are refunded; processing-job cancellation and deletion may complete later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Numeric asynchronous render job ID to cancel and delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Render Job Result

**Slug:** `SCREENSHOTBASE_DOWNLOAD_JOB_RESULT`

Retrieve the retained output of a completed asynchronous render job in the representation selected when the job was created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Numeric completed render job ID whose result should be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Status

**Slug:** `SCREENSHOTBASE_GET_ACCOUNT_STATUS`

Return the connected Screenshotbase account's active plan and current monthly and grace render quota usage.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Render Job

**Slug:** `SCREENSHOTBASE_GET_JOB`

Get the current status, result metadata, or failure details for one asynchronous render job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Numeric asynchronous render job ID returned by Render or List Jobs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Rendering Devices

**Slug:** `SCREENSHOTBASE_LIST_DEVICES`

List every documented device profile that can be passed to the render action's viewport_device field.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Render Jobs

**Slug:** `SCREENSHOTBASE_LIST_JOBS`

Return one newest-first page of asynchronous render jobs, optionally filtered by status, with a cursor for older jobs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum jobs to return in this page (1-100). |
| `cursor` | string | No | Opaque cursor returned by a previous call. Pass it back unchanged to fetch older jobs; omit it for the first page. |
| `status` | string ("queued" | "processing" | "completed" | "failed") | No | Return only jobs in this status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Render Content with POST

**Slug:** `SCREENSHOTBASE_RENDER`

Render a URL, supplied HTML, or supplied Markdown through POST as an image, PDF, Markdown, SVG, or rendered HTML. Use this action for HTML or Markdown input and POST-only PDF header or footer templates; prefer RENDER_URL for a URL-only request. Optionally create an asynchronous job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pdf` | object | No | PDF-only sizing, margins, templates, and accessibility settings. |
| `url` | string | No | Public URL to render; provide exactly one of url, html, or markdown. |
| `html` | string | No | HTML document to render; provide exactly one input source. |
| `locale` | object | No | Geographic, language, time-zone, and locale emulation. |
| `output` | object | No | Output format, delivery, quality, and image settings. |
| `capture` | object | No | Full-page, element, clipping, and background behavior. |
| `network` | object | No | Target-page blocking, proxy, headers, cookies, and authorization. |
| `markdown` | string | No | Markdown document to render; provide exactly one input source. |
| `viewport` | object | No | Browser viewport and device-emulation settings. |
| `navigation` | object | No | Readiness checks and browser automation before capture. |
| `diagnostics` | object | No | Troubleshooting and best-effort render behavior. |
| `async_options` | object | No | Asynchronous job creation and callback settings. |
| `content_rules` | object | No | Content validation and page-cleanup rules. |
| `markdown_options` | object | No | Markdown-output extraction behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Render URL with GET

**Slug:** `SCREENSHOTBASE_RENDER_URL`

Render a public URL through Screenshotbase's URL-only GET /v1/take operation as an image, PDF, Markdown, SVG, or rendered HTML, optionally as an async job. Prefer this action for public URL-only requests; use RENDER for target headers, cookies, authorization, credential-bearing proxies, supplied HTML, supplied Markdown, or POST-only PDF header and footer templates. This charged GET is sent once without automatic HTTP retries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pdf` | object | No | PDF-only sizing, margins, and accessibility settings. |
| `url` | string | Yes | Public HTTP or HTTPS URL to render with the GET /v1/take operation. |
| `locale` | object | No | Geographic, language, time-zone, and locale emulation. |
| `output` | object | No | Output format, delivery, quality, and image settings. |
| `capture` | object | No | Full-page, element, clipping, and background behavior. |
| `network` | object | No | Non-sensitive target-page request blocking, user-agent, and CSP options. Use RENDER (POST) when target headers, cookies, authorization, or a credential-bearing proxy is required. |
| `viewport` | object | No | Browser viewport and device-emulation settings. |
| `navigation` | object | No | Readiness checks and browser automation before capture. |
| `diagnostics` | object | No | Troubleshooting and best-effort render behavior. |
| `async_options` | object | No | Asynchronous job creation and callback settings. |
| `content_rules` | object | No | Content validation and page-cleanup rules. |
| `markdown_options` | object | No | Markdown-output extraction behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
