Skip to main content
A task starts a browser on a public page, works toward your goal, and closes the browser for you. It answers at once with an id, and the task runs in the background.
The TypeScript SDK has stophy.browser.task(...) and stophy.browser.task.status(...) with the same fields. Starting a task is free. See Pricing.

Read the result

Send the id to POST /v1/browser/task/status until status is done. The call is free. While the task runs, result is null.
  • result.done says whether the goal was met. When it is false, reason says why.
  • answer is the result in words. steps lists what the task clicked. url and title are the page it ended on.
  • With a schema, fields holds one value per property and confidence rates each from 0 to 1. A field no page stated is null.
  • costUsd is what the task cost. creditsUsed is the older field for the same amount.
A task is kept for 24 hours after it starts.

Request fields

A task stops before anything that pays, books, sends, submits or deletes, and never signs in. It takes up to 50 steps and 10 minutes. For a login or a flow you control, open a browser session and use Execute.

Errors

  • Too many tasks open: 429 rateLimited. See Rate limits.
  • A maxCost below one browser minute, or a schema that is not an object with properties: 400 invalidRequest.
  • An unknown id, or one older than 24 hours: 404 notFound.
  • A balance too low to cover maxCost: 402 insufficientCredits, and the task does not start.