Skip to main content
POST
Best for a few steps a person would click through on a public site, like a search with filters or a form to fill without sending it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

A value you choose for one call. Send the same key with the same method, path and body within 24 hours and the first answer comes back with idempotent-replayed: true, with the same cost headers and no second charge. A call that sends zeroDataRetention and answers with page data is not kept, so a retry runs again. Needs an API key.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
url
string
required
goal
string
required

What to get done on the page, in one or two sentences.

Required string length: 1 - 1000
values
string

Values the steps will need, such as: from London, to Istanbul, date 2026-12-01. They are typed only on the start page's site.

Maximum string length: 1000
schema
object

Fields to fill when the task is done, as a JSON Schema object. Each one is checked against the pages the task saw and comes back null when no page states it.

maxSteps
integer
default:50

The most steps the task may take, 1 to 50.

Required range: 1 <= x <= 50
maxCost
number

The most the task may spend, in US dollars. Browser time is $0.84 per hour, so each minute is $0.014, and the task stops when this is spent. Leave out to allow the full 10 minutes.

Response

The data, and what this call cost in dollars.

success
any
required
data
object
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required