Skip to content

Quick actions API

Set up your agent

Give your coding agent a Steel browser and the Steel skills, so that it browses and writes Steel code the right way. Learn more

Install the Steel CLI. It signs you in and installs the skills for your coding agents.

curl -fsS https://setup.steel.dev | sh

Or send this prompt to your coding agent, and it does the same:

Read https://setup.steel.dev/install.md and follow it to set up Steel for this coding client.
Then continue my requested task using the installed Steel skill.

Set up your agent →

A Quick action opens a web page and returns the result in one request, with no session to manage. These endpoints create a PDF, scrape a page and capture a screenshot. For the base URL and authentication, see API conventions. For the error codes, see Errors.

The first example is a complete program. The later examples use its client.

Endpoints

Create a PDF

POST/v1/pdf

Opens a web page and returns the URL of a PDF of it.

Parameters

NameTypeRequiredDescription
urlstring (uri) · bodyYesThe URL of the page.
delaynumber · bodyNoMilliseconds to wait before Steel creates the PDF.
useProxyboolean · bodyNoUse a Steel residential proxy.
projectIdstring (uuid) · bodyNoThe project to run the action in. Required with an organization key.

Response

FieldTypeDescription
urlstring (uri)The URL of the PDF.

See PDF.

curl -X POST https://api.steel.dev/v1/pdf \
  -H "steel-api-key: $STEEL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Scrape a page

POST/v1/scrape

Opens a web page and returns its content in the formats that you ask for, with its metadata and links.

Parameters

NameTypeRequiredDescription
urlstring · bodyYesThe URL of the page. A URL without a scheme is fetched over HTTPS.
formatstring[] · bodyNoThe formats of the content: html, readability, cleaned_html or markdown.Default ["html"].
screenshotboolean · bodyNoAdd a screenshot to the response.
pdfboolean · bodyNoAdd a PDF to the response.
delaynumber · bodyNoMilliseconds to wait before Steel scrapes the page.
useProxyboolean · bodyNoUse a Steel residential proxy.
projectIdstring (uuid) · bodyNoThe project to run the action in. Required with an organization key.

Response

FieldTypeDescription
contentobjectThe content in each format that you asked for: html, cleaned_html, markdown and readability.
metadataobjectThe page metadata, such as title, description, language, canonical, the Open Graph fields, jsonLd and statusCode, the HTTP status of the page.
screenshotobjectWith screenshot: true: the url of the screenshot.
pdfobjectWith pdf: true: the url of the PDF.

See Scrape.

curl -X POST https://api.steel.dev/v1/scrape \
  -H "steel-api-key: $STEEL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "format": ["markdown"]}'

Capture a screenshot

POST/v1/screenshot

Opens a web page and returns the URL of a screenshot of it.

Parameters

NameTypeRequiredDescription
urlstring (uri) · bodyYesThe URL of the page.
fullPageboolean · bodyNoCapture the whole page, not only the viewport.Default false.
delaynumber · bodyNoMilliseconds to wait before Steel captures the screenshot.
useProxyboolean · bodyNoUse a Steel residential proxy.
projectIdstring (uuid) · bodyNoThe project to run the action in. Required with an organization key.

Response

FieldTypeDescription
urlstring (uri)The URL of the screenshot.

See Screenshot.

curl -X POST https://api.steel.dev/v1/screenshot \
  -H "steel-api-key: $STEEL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "fullPage": true}'