Screenshot

onesimpleapi.screenshot

ActionBusiness appsconnection required

Calls the One Simple API API with the connection's credentials.

Capture a web page or a block of HTML and return the image's URL.

Ask about One Simple API All One Simple API nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: API key
Providers: One Simple API
Secret shape: the API token, or {"api_token": "…"}
Config it needs: base_url
Resolved by: config.connection_id, else node.connection_id

Configuration

6 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
url The address of the page to render. Give this or 'html', not both.	string	No	—	url format	https://onesimpleapi.com/docs
html A block of HTML to render instead of fetching a page.	string	No	—	—	<h1>Invoice 1024</h1>
screen The screen to render at: retina, phone, phone-landscape, tablet, tablet-landscape, 4k, 8k, or a custom size written as custom:WIDTHxHEIGHT.	string	No	—	matches ^(retina\|phone\|phone-landscape\|tablet\|tablet-landscape\|4k\|8k\|custom:\d+x\d+)$	retina
full_page Capture the whole length of the page rather than just the visible area.	boolean	No	false	—	—
force Regenerate now instead of reusing the result One Simple API already has for this input.	boolean	No	false	—	—
include_background Include the page's background images and colours; One Simple API includes them by default for screenshots.	boolean	No	true	—	—

At least one of url, html must be set.

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "force": false,
  "full_page": false,
  "html": "<h1>Invoice 1024</h1>",
  "include_background": true,
  "screen": "retina",
  "url": "https://onesimpleapi.com/docs"
}

Output

One shape.

result

The provider's response object, as returned.

Extra keys beyond the ones listed can appear.

{}

Related One Simple API nodes

See Screenshot run in a workflow.

In a technical demo we add the One Simple API connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales