Skip to main content
Cloudlayer logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: CLOUDLAYER
  • Version: 20261101_00

Tools

Slug: CLOUDLAYER_ADD_STORAGEAdd a user-owned S3-compatible storage configuration for storing generated assets. This action allows Enterprise plan users to configure their own S3-compatible storage (AWS S3, DigitalOcean Spaces, Wasabi, MinIO, etc.) instead of using the built-in cloud storage included with Cloudlayer accounts. Note: User storage is only available on Enterprise plans. Standard plans will receive an ‘allowed: false’ response indicating the feature requires a plan upgrade.

Input Parameters

string
required
A unique, human-readable title to identify this storage configuration in your account. Must be unique across all storage credentials.
string
Custom endpoint URL for S3-compatible storage providers like DigitalOcean Spaces or MinIO. Not required for AWS S3.
string
required
Storage region code (e.g., ‘us-east-1’ for AWS, ‘nyc3’ for DigitalOcean). Required for all providers.
string ("aws" | "azure" | "gcp" | "s3")
required
Storage provider type. Use ‘aws’ for Amazon S3, ‘azure’ for Azure Blob, ‘gcp’ for Google Cloud Storage, or ‘s3’ for any S3-compatible storage (e.g., DigitalOcean Spaces, Wasabi, MinIO).
string
required
The access key ID from your storage provider (e.g., AWS Access Key ID).
string
required
Name of the bucket (AWS S3, GCP) or container (Azure) where assets will be stored.
string
required
The secret access key from your storage provider. This is encrypted before storage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_CONVERT_HTML_TO_IMAGEConvert HTML content to a PNG, JPG, or WebP image using the v2 API, with viewport configuration, transparency, auto-scroll, and custom wait conditions. Returns job details; the image asset may be available once processing completes.

Input Parameters

string
required
The HTML content to convert. Will be automatically base64-encoded before sending to the API.
boolean
Automatically trim whitespace around the rendered content.
boolean
Override default async behavior. Set to true for async processing, false for synchronous.
integer
Milliseconds to wait before conversion after page load.
number
Webpage rendering scale factor (0.1-2.0).
integer
Width of the output image in pixels.
integer
Height of the output image in pixels. If omitted, auto-calculated based on content.
boolean
If true, Content-Disposition is ‘inline’; if false, ‘attachment’.
string
Storage configuration. Use boolean to enable/disable, or object for advanced configuration.
integer
Maximum time in milliseconds to wait for rendering.
string
HTTPS URL to receive notification when the job completes (for async jobs).
string
Custom filename for the generated image (used in Content-Disposition header).
string
IANA timezone identifier (e.g., ‘America/New_York’, ‘Europe/London’).
object
Viewport dimensions for rendering the HTML content.
string ("png" | "jpg" | "webp")
Output image format. Options: ‘png’, ‘jpg’, or ‘webp’. Default is ‘png’.
boolean
Set page orientation to landscape.
string
Project ID for organizing the generated assets.
string ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")
Wait condition before capturing: ‘load’, ‘domcontentloaded’, ‘networkidle0’, or ‘networkidle2’.
boolean
Auto-scroll the page to load lazy content before capturing.
boolean
Enable transparent background for PNG images. Only applicable for PNG format.
object
Configuration for generating a thumbnail preview.
object
Configuration for waiting for a specific selector before conversion.
boolean
Use CSS-defined page size instead of viewport dimensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_CONVERT_HTML_TO_PDF_V2Tool to convert HTML content to PDF using CloudLayer v2 API. Use when you need to generate a PDF from raw HTML with advanced options like custom paper size, margins, headers/footers, and viewport settings. The HTML is automatically Base64 encoded before sending to the API.

Input Parameters

string
required
Raw HTML string to convert to PDF. Will be automatically Base64 encoded.
boolean
Override default async behavior (v2 default: true)
integer
Additional delay in ms after page load before PDF generation
number
Scale of webpage rendering between 0.1 and 2.0
string
Custom paper width with units (overrides format)
string ("letter" | "legal" | "tabloid" | "ledger" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "a6")
Predefined paper format (lowercase)
string
Custom paper height with units (overrides format)
boolean
If true, returns inline content instead of attachment
object
Page margin sizes. Can be specified as number (pixels) or string with units.
string
Storage configuration. True for default storage, false to disable, or object with storage ID.
integer
Maximum time in ms to wait for page load
string
HTTPS URL to receive job completion notification
string
Custom filename for the generated PDF
string
Time zone for rendering (IANA time zone identifier)
object
Browser viewport dimensions for rendering HTML content.
boolean
Paper orientation; true for landscape, false for portrait
string
Project ID for organizing jobs
string ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")
When to consider navigation complete. ‘networkidle2’ waits until 2 or fewer network connections for 500ms
boolean
Auto-scroll page to trigger lazy-loading content
string
Paper ranges to print, e.g., ‘1-5’ or ‘1,3,5’
HTML template for header or footer with class tokens.
object
HTML template for header or footer with class tokens.
string
Generate thumbnail preview of first page. Can be boolean or config object.
boolean
Include background graphics/colors in the PDF
object
Configuration to wait for a specific CSS selector before rendering.
boolean
Use CSS @page size over width/height settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_CONVERT_URL_TO_PDF_GETConvert a URL to PDF using a GET request with minimal parameters. The v2 API normally returns a job for asynchronous processing rather than an immediately available PDF.

Input Parameters

string
required
The URL to convert to PDF. Must be a publicly accessible web page.
integer
Timeout in milliseconds for the conversion request. Default is 30000ms (30 seconds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_DELETE_STORAGEDelete a user storage configuration by its ID. A configuration already reported as nonexistent is treated as a successful no-op.

Input Parameters

string
required
Unique identifier of the storage configuration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_GET_ACCOUNT_INFOTool to retrieve Cloudlayer account usage, credits, and document counts. Use when monitoring account limits and subscription status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_GET_ASSETTool to retrieve a specific asset by its ID. Use when you need to fetch metadata or download URL of an existing asset after its generation.

Input Parameters

string
required
The unique identifier (UUID) of the asset to retrieve. Can be obtained from the list_assets action or from the response of an asset generation action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_GET_JOB_BY_IDRetrieve details of a specific Cloudlayer job by its ID. Use this to check the status of an async job, get the asset download URL after completion, or view job parameters. Returns 401 if the job ID doesn’t exist or doesn’t belong to your account.

Input Parameters

string
required
The unique identifier (UUID) of the job to retrieve. Obtain this from job creation responses or list_jobs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_GET_STATUSTool to test API reachability. Use when checking if the Cloudlayer API is available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_GET_STORAGE_BY_IDTool to retrieve a specific storage configuration by its ID. Use when you need to inspect or validate details of a user storage configuration.

Input Parameters

string
required
Unique identifier of the storage configuration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_LIST_ASSETSList assets in your CloudLayer account with cursor-based pagination. Returns PDFs and images generated via HTML/URL conversion jobs. Use this to find asset IDs for further operations like downloading or deleting assets.

Input Parameters

integer
Maximum number of assets to return per page (1-100, default 10).
string
Asset ID to use as a cursor for pagination. Returns assets created after this asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_LIST_JOBSList jobs in your CloudLayer account with cursor-based pagination. Use when you need to view your recent jobs and their statuses.

Input Parameters

integer
Maximum number of jobs to return per page (1-100, default 10).
string
Job ID to use as a cursor for pagination. Returns jobs created after this job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_LIST_STORAGERetrieves all user storage configurations (S3-compatible buckets) for the authenticated Cloudlayer account. Use this to view configured external storage destinations where generated documents can be saved. Note: User Storage is an Enterprise plan feature. Non-Enterprise accounts will receive an empty list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_TEMPLATE_TO_PDFGenerate a PDF document from an HTML/Nunjucks template with dynamic data. Provide either: - A templateId for predefined templates from CloudLayer’s template library, OR - A base64-encoded template string containing custom HTML/Nunjucks markup. The data parameter populates template variables (e.g., {{name}}, {{items}}) with your JSON data. By default, jobs run asynchronously and return a job ID to poll for completion via get_job_by_id.

Input Parameters

string
required
JSON string containing key-value pairs to populate template variables. For example, if your template has {{name}} and {{items}}, provide ’{“name”: “John”, “items”: [“A”, “B”]}’.
boolean
If true (default), returns immediately with a job ID for status polling. Set to false to wait for PDF generation to complete before returning.
integer
Delay before conversion in milliseconds.
string ("letter" | "legal" | "tabloid" | "ledger" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "a6")
Paper format (letter, legal, tabloid, ledger, a0–a6).
boolean
If true, returns the PDF inline rather than as attachment.
object
Page margin sizes.
string
If true (default), saves the PDF to CloudLayer storage and returns an asset URL. Set to false to return the PDF directly in the response (requires async_=false). Can also provide a StorageOption object with a custom storage ID.
string
Filename for the generated PDF when inline=false.
string
Base64-encoded HTML or Nunjucks template content (required if templateId is omitted).
boolean
Use landscape orientation.
boolean
Auto-scroll to force lazy-loaded content.
string
Page ranges to print, e.g., ‘1-3,5’.
string
ID of a predefined template (required if template is omitted).
HTML template for footer with tokens ‘{{pageNumber}}’ and ‘{{totalPages}}’.
string
HTML template for header with tokens ‘{{pageNumber}}’ and ‘{{totalPages}}’.
string
Generate a preview image; use object for settings or true for defaults.
boolean
Print background graphics.
boolean
Prefer @page CSS size over width/height/format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_URL_TO_IMAGE_POSTConverts a webpage URL to an image (PNG, JPG, or WebP). Supports custom viewport settings, wait conditions, transparency, auto-scroll, and thumbnail preview generation. The API is asynchronous - use the returned job ID to poll for results.

Input Parameters

string
required
URL of the webpage to capture as an image.
object
Rectangular region to capture instead of the full page.
boolean
Trim whitespace from the edges of the image.
integer
Milliseconds to wait before capture after page loads.
number
Rendering scale factor (0.1 to 2.0).
boolean
If true, Content-Disposition is ‘inline’; if false, ‘attachment’.
array
Cookies to set before loading the page.
object
Custom HTTP headers to send with the request.
integer
Image quality (1-100) for jpg/webp formats. Ignored for png.
integer
Maximum time in ms to wait for page load (default: 30000).
string
Custom filename for the generated image (without extension).
string
ICU timezone identifier (e.g., ‘America/New_York’, ‘Europe/London’).
object
Viewport size and device scale settings for the screenshot.
string ("png" | "jpg" | "webp")
Output image format: png, jpg, or webp.
string
Custom User-Agent header string.
string ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")
Navigation wait condition: load, domcontentloaded, networkidle0 (0 connections), or networkidle2 (2 or fewer connections).
boolean
Auto-scroll the page to the bottom before capturing.
boolean
Remove default white background for transparent PNG/WebP output.
object
Basic authentication credentials for accessing the webpage.
object
Configuration for generating a thumbnail preview of the image.
object
Configuration to wait for a specific DOM element before capturing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDLAYER_URL_TO_PDF_POSTConvert a URL to PDF using a POST request, with options for paper size, margins, headers, and footers.

Input Parameters

string
required
Publicly accessible web page URL to convert to PDF
integer
Additional delay in ms after page load before PDF generation
number
Scale of webpage rendering between 0.1 and 2.0
string
Custom paper width with units (overrides format)
string ("letter" | "legal" | "tabloid" | "ledger" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "a6")
Predefined paper format (lowercase)
string
Custom paper height with units (overrides format)
boolean
If true, returns inline content instead of attachment
object
Page margin sizes. Can be specified as number (pixels) or string with units (e.g., ‘0.4in’).
array
List of cookies to set before rendering the page
integer
Maximum time in ms to wait for page load
string
Custom filename for the generated PDF
object
Browser viewport settings before PDF generation.
boolean
Paper orientation; true for landscape, false for portrait
string
Project ID for organizing jobs
string ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")
When to consider navigation complete. ‘networkidle2’ waits until 2 or fewer network connections for 500ms
boolean
Auto-scroll page to trigger lazy-loading content
string
Paper ranges to print, e.g., ‘1-5’ or ‘1,3,5’
object
HTTP Basic authentication credentials for accessing the URL.
HTML template for footer. Supports class tokens: .date, .title, .url, .pageNumber, .totalPages
string
HTML template for header. Supports class tokens: .date, .title, .url, .pageNumber, .totalPages
boolean
Include background graphics/colors in the PDF
boolean
Use CSS @page size over width/height settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not