Running tasks
Start Browsing Task
Start a new browsing task with the given specifications.
This endpoint allows you to initiate a new browsing task by providing the necessary details such as the goal, starting URL, and desired output type. The task will be created and started asynchronously.
POST
/
browse
Body
application/json
Specifications for the browsing task
goal
string
requiredThe goal or objective of the browsing task
startUrl
string
requiredThe URL where the browsing task should begin
outputType
enum<string>
The type of output expected from the task, Optional (by default, the task will output a string)
Available options:
string
, list[string]
, url
, list[url]
completionCallbackUrl
string | null
An optional URL to be called when the task is completed.
Response
200 - application/json
taskId
string
requiredgoal
string
requiredstartUrl
string
requiredrevision
string
requiredstatus
enum<string>
requiredAvailable options:
WAITING
, RUNNING
, COMPLETED
, FAILED
, CANCELLED
outputType
enum<string>
requiredAvailable options:
string
, list[string]
, url
, list[url]
output
required
errors
object[] | null
requiredsteps
object[]
required