> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Screenshot API

> Screenshot API renders webpages and custom HTML as images, PDFs, videos, or extracted content and supports paid asynchronous bulk capture jobs.

![Screenshot API logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/screenshot_api.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=e23dbc4d1a4d113bb05033c96e0a8525)

* **Category:** images & design
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 5
* **Triggers:** 0
* **Slug:** `SCREENSHOT_API`
* **Version:** 20261030\_00

## Tools

> [accordion] Create Bulk CSV Job
>
> **Slug:** `SCREENSHOT_API_CREATE_BULK_CSV_JOB`
>
> Upload a CSV file to start a paid asynchronous bulk screenshot job and return the provider's complete job acceptance payload containing its UUID.
>
> #### Input Parameters
>
> **csv\_file** `object` *required*
>
> CSV attachment supplied by Composio's attachment flow. Pass the attachment object unchanged; its file must contain a required url column of fully qualified HTTPS URLs and may contain documented render-option columns.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bulk JSON Job
>
> **Slug:** `SCREENSHOT_API_CREATE_BULK_JSON_JOB`
>
> Start a paid asynchronous bulk screenshot job from up to 50 JSON request items and return the provider's complete job acceptance payload containing its UUID.
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> Bulk capture items. Provide between 1 and 50 items; 50 is the documented conservative maximum.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Bulk Results
>
> **Slug:** `SCREENSHOT_API_DOWNLOAD_BULK_RESULTS`
>
> Download the processed result CSV for a completed paid bulk screenshot job UUID.
>
> #### Input Parameters
>
> **job\_uuid** `string` *required*
>
> UUID of a completed bulk job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Job Status
>
> **Slug:** `SCREENSHOT_API_GET_BULK_JOB_STATUS`
>
> Get progress and success/failure counts for a paid asynchronous bulk screenshot job UUID.
>
> #### Input Parameters
>
> **job\_uuid** `string` *required*
>
> UUID returned by a bulk JSON or CSV create request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Render Screenshot
>
> **Slug:** `SCREENSHOT_API_RENDER_SCREENSHOT`
>
> Render a webpage or custom HTML and return a stored image, PDF, or video URL plus optional extracted content links. A custom result filename can replace an existing stored file with the same name.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Fully qualified webpage URL; required even when custom\_html is supplied.
>
> **cache** `object`
>
> Stored-result caching behavior.
>
> **storage** `object`
>
> Route output to a dashboard-configured storage integration.
>
> **blocking** `object`
>
> Hide common overlays or block selected browser resource types.
>
> **viewport** `object`
>
> Viewport and capture geometry.
>
> **file\_type** `string ("png" | "jpg" | "jpeg" | "webp" | "pdf" | "webm" | "mp4" | "gif")`
>
> Output format; video formats require scrolling or video settings and may be plan-gated.
>
> **page\_load** `object`
>
> Navigation, waiting, and page-script controls.
>
> **scrolling** `object`
>
> Scrolling screenshot or video controls; these features may be plan-gated.
>
> **appearance** `object`
>
> Image quality and page appearance controls.
>
> **extraction** `object`
>
> Additional page data to extract alongside the screenshot URL.
>
> **custom\_html** `string`
>
> Raw HTML to render instead of the URL content.
>
> **pdf\_options** `object`
>
> PDF-only page settings.
>
> **browser\_context** `object`
>
> Browser identity, target authentication, proxy, and location settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
