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. It answers at once with an id; ask browser.task.status for the result. A task takes up to 20 steps and 3 minutes, and stops before anything that pays, books, sends, submits or deletes. Stophy never logs in to a site.

Price

3 credits for each step the task takes, up to maxSteps and maxCost. A task that ends before its first step costs nothing. Starting a task sets aside the most it can cost, and what it does not use comes back when it ends. See Pricing for what credits cost.

Authorizations

Authorization
string
header
required

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

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

The public page to start on, such as https://www.python.org.

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 read from the last page when the task is done, as a JSON Schema object. Each one is checked against the page and comes back null when the page does not state it.

maxSteps
integer
default:20

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

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

The most the task may spend, in US dollars at the standard price of $0.002 a credit. Each step is 3 credits, so $0.006. Leave out to allow maxSteps steps.

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required