> ## 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.

# Apiflash

> ApiFlash is a website screenshot API that allows users to capture high-quality screenshots of web pages programmatically.

![Apiflash logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/apiflash.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=b22dcb03147553e640bca75f922da05b)

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

## Tools

> [accordion] Batch Capture Screenshots
>
> **Slug:** `APIFLASH_BATCH_CAPTURE_SCREENSHOTS`
>
> Capture screenshots for a list of URLs using shared capture settings. Each URL is requested separately, and the tool stops if a capture fails; successful results are keyed by input URL.
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> List of full URLs to capture; each must include protocol (http or https).
>
> **fresh** `boolean`
>
> When true, bypasses API cache and forces a new screenshot capture. Use for frequently updated pages.
>
> **width** `integer`
>
> Browser viewport width in pixels. Default 1920 for desktop; use 375-414 for mobile simulation.
>
> **format** `string ("jpeg" | "png" | "webp")`
>
> Output image format for all screenshots. JPEG is smallest, PNG supports transparency, WebP offers best compression.
>
> **height** `integer`
>
> Browser viewport height in pixels. Only used when full\_page is false. Default 1080 for desktop.
>
> **full\_page** `boolean`
>
> When true, captures the entire scrollable page instead of just the visible viewport.
>
> #### 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] Capture Screenshot
>
> **Slug:** `APIFLASH_CAPTURE_SCREENSHOT`
>
> Capture a screenshot of a website for documentation, testing, or monitoring. Customize the viewport, full-page or element capture, image quality, and geolocation. The default JSON response provides a screenshot URL and, when requested, URLs to extracted HTML or text.
>
> #### Input Parameters
>
> **js** `string`
>
> Additional JavaScript code to be injected into the page before capturing. Should be URL encoded.
>
> **css** `string`
>
> A CSS string to inject in the web page when capturing the screenshot. Should be URL encoded.
>
> **ttl** `integer`
>
> Number of seconds the screenshot is cached. From 0 seconds to 2592000 seconds (30 days). Default is 86400.
>
> **url** `string` *required*
>
> The complete URL of the website to capture. Must include the protocol (http\:// or https\://). Example: '[https://example.com](https://example.com)'
>
> **crop** `string`
>
> Capture a screenshot of an area of the page. Format: 'left,top,width,height' (e.g., '10,20,50,100' captures an area 50 pixels wide and 100 pixels high).
>
> **delay** `integer`
>
> The delay, in seconds, to wait after the page is loaded before capturing the screenshot. From 0 to 10 seconds. Default is 0.
>
> **fresh** `boolean`
>
> Force the API to capture a fresh new screenshot instead of returning a screenshot from the cache.
>
> **proxy** `string`
>
> The address of a proxy server through which the screenshot should be captured. Format: 'address:port' or 'user:password\@address:port'.
>
> **width** `integer`
>
> The width, in pixels, of the viewport to use. Default is 1920.
>
> **format** `string ("jpeg" | "png" | "webp")`
>
> The image format of the captured screenshot. Either jpeg (default), png, or webp.
>
> **height** `integer`
>
> The height, in pixels, of the viewport to use. Ignored if full\_page is true. Default is 1080.
>
> **no\_ads** `boolean`
>
> Prevent ads from being displayed. Blocks requests from popular ad-networks and hides common ad spaces.
>
> **s3\_key** `string`
>
> The object key to use when uploading the screenshot.
>
> **cookies** `string`
>
> A semicolon separated list of cookies to be used when capturing the screenshot (e.g., 'cookie1=value1;cookie2=value2'). Should be URL encoded.
>
> **element** `string`
>
> Capture a screenshot of the first element matched by the given CSS selector. Ignored if full\_page is true. Should be URL encoded.
>
> **headers** `string`
>
> A semicolon separated list of headers to be used when capturing the screenshot (e.g., 'Header1=value1;Header2=value2'). Should be URL encoded.
>
> **quality** `integer`
>
> The quality of the image between 0 and 100. Works with jpeg and webp formats. Default is 80.
>
> **accuracy** `integer`
>
> The accuracy value, in meters, to use when emulating geo-location. Default is 0.
>
> **latitude** `number`
>
> The latitude to use when emulating geo-location between -90 and 90.
>
> **wait\_for** `string`
>
> Wait until the provided CSS selector matches an element present in the page before capturing. If no item matches after 15 seconds, capture is aborted with an error.
>
> **full\_page** `boolean`
>
> Set to true to capture the entire page of the target website.
>
> **longitude** `number`
>
> The longitude to use when emulating geo-location between -180 and 180.
>
> **s3\_bucket** `string`
>
> The name of the S3 bucket to upload the screenshot to.
>
> **s3\_region** `string`
>
> The AWS region to use to upload the screenshot to AWS S3. Might be needed for custom S3 compatible storage providers.
>
> **time\_zone** `string`
>
> The time zone to use when capturing screenshots. Accepts standard time zone database names (e.g., 'Europe/Paris' or 'America/New\_York'). Should be URL encoded.
>
> **user\_agent** `string`
>
> Sets the User-Agent header to emulate a particular device when making screenshots. Should be URL encoded.
>
> **wait\_until** `string ("dom_loaded" | "page_loaded" | "network_idle")`
>
> Wait until the given criterion is satisfied. Options: dom\_loaded, page\_loaded, network\_idle (default).
>
> **ip\_location** `string`
>
> An ISO alpha-2 country code designating the country associated with the IP address of the proxy. Only available for custom enterprise plans.
>
> **no\_tracking** `boolean`
>
> Prevent tracking scripts from running and block requests from popular tracking services.
>
> **s3\_endpoint** `string`
>
> Custom S3 compatible storage provider endpoint URL. Leave empty to use AWS S3.
>
> **scroll\_page** `boolean`
>
> Set to true to scroll through the entire page before capturing a screenshot. Useful to trigger animations or lazy loaded elements.
>
> **transparent** `boolean`
>
> Capture a screenshot with transparency enabled. The background color of the page body should be set to transparent. Only works with png format.
>
> **extract\_html** `boolean`
>
> Extract the HTML of the page at the same time the screenshot is made. Only works when response\_type is 'json'.
>
> **extract\_text** `boolean`
>
> Extract the text of the page at the same time the screenshot is made. Only works when response\_type is 'json'.
>
> **scale\_factor** `integer`
>
> Specifies the device scale factor. Acceptable values are 1 (standard resolution) or 2 (high definition for retina displays). Default is 1.
>
> **response\_type** `string ("image" | "json")`
>
> The type of response to return. Can be 'image' (binary data) or 'json' (JSON document with url, extracted\_html, and extracted\_text fields). Default is 'json' for easier handling.
>
> **s3\_secret\_key** `string`
>
> The AWS secret access key to use to upload the screenshot to AWS S3.
>
> **fail\_on\_status** `string`
>
> A comma separated list of HTTP status codes that should make the API call fail instead of returning a screenshot. Hyphen separated ranges can be used (e.g., '400,404,500-511').
>
> **accept\_language** `string`
>
> Sets the Accept-Language header on requests to the target URL, allowing screenshots with specific language. Example: 'en-US'.
>
> **element\_overlap** `boolean`
>
> Also capture the elements that overlap the element targeted by the element parameter.
>
> **thumbnail\_width** `integer`
>
> The width, in pixels, of the thumbnail to generate. The aspect ratio will be preserved. Ignored if full\_page is true.
>
> **s3\_access\_key\_id** `string`
>
> The AWS access key id to use to upload the screenshot to AWS S3.
>
> **no\_cookie\_banners** `boolean`
>
> Prevent cookie banners and popups from being displayed.
>
> #### 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] Capture Website Screenshot (POST)
>
> **Slug:** `APIFLASH_CAPTURE_WEBSITE_SCREENSHOT_POST`
>
> Capture a screenshot of any website. Returns a URL to the generated screenshot image. Supports full-page captures, custom viewport sizes, and multiple image formats (JPEG, PNG, WebP). Use this tool when you need to visually capture web pages for documentation, monitoring, or analysis.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The complete URL of the website to capture (must include protocol, e.g., '[https://example.com](https://example.com)').
>
> **delay** `integer`
>
> Wait time in seconds (0-10) before capturing the screenshot. Useful for pages with animations or delayed content loading.
>
> **fresh** `boolean`
>
> Set to true to force a new screenshot, bypassing any cached version. Use for pages with frequently changing content.
>
> **width** `integer`
>
> Viewport width in pixels. Default is 1920. Use smaller values (e.g., 375) for mobile views.
>
> **format** `string ("jpeg" | "png" | "webp")`
>
> Output image format. 'jpeg' (default) is best for most cases, 'png' supports transparency, 'webp' offers smaller file sizes.
>
> **height** `integer`
>
> Viewport height in pixels. Default is 1080. Ignored when full\_page is true.
>
> **quality** `integer`
>
> Image quality from 0-100 (only for jpeg/webp). Default is 80. Higher values = better quality but larger file size.
>
> **full\_page** `boolean`
>
> Set to true to capture the entire scrollable page. When false (default), captures only the visible viewport.
>
> #### 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 Quota Information
>
> **Slug:** `APIFLASH_GET_QUOTA_INFORMATION`
>
> Tool to retrieve current API quota usage and limits. Use after authentication to monitor usage and reset times.
>
> #### 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 Screenshot Metadata
>
> **Slug:** `APIFLASH_GET_SCREENSHOT_METADATA`
>
> Retrieve metadata (file size, MIME type) for a previously captured screenshot. Use this tool when you need to check the size or format of a screenshot without downloading the full image. Requires the screenshot URL from a prior capture action.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Full URL of the screenshot image returned from a previous capture. This URL is obtained from the 'url' field in the response of a screenshot capture action.
>
> #### 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
