Skip to main content
POST
/
v1beta
/
tasks
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_state": "not_ready",
  "display_name": "<string>",
  "task": "<string>",
  "website": "<string>",
  "input_schema": "<string>",
  "output_schema": "<string>",
  "is_fully_autonomous": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "failure_info": {
    "category": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Body

application/json
​
display_name
string
required

Short title shown in the dashboard. Informational only; not used to generate the task.

​
task
string
required

Detailed explanation of the task to be performed.

​
website
string<uri>
required

The website to perform the task on.

Required string length: 1 - 2083
​
input_schema
string
required

Task input parameters in the form of a JSON schema.

​
output_schema
string
required

Task output in the form of a JSON schema.

​
is_fully_autonomous
boolean
default:false

If true, the server will run the browser task autonomously. If false, the user must complete the task manually in a spawned browser.

Response

Successful response

​
id
string<uuid>
required

Unique identifier for the object.

​
current_state
enum<string>
required

Current state of the task, in particular whether it is ready to use.

Available options:
not_ready,
waiting_for_manual_completion,
ready,
failed
​
display_name
string
required

Short title shown in the dashboard. Informational only.

​
task
string
required

Detailed explanation of the task to be performed.

​
website
string<uri>
required

The website to perform the task on.

Required string length: 1 - 2083
​
input_schema
string
required

Task input parameters in the form of a JSON schema.

​
output_schema
string
required

Task output in the form of a JSON schema.

​
is_fully_autonomous
boolean
required

If true, the server will run the browser task autonomously.

​
created_at
string<date-time>
required

Timestamp when the object was created.

​
updated_at
string<date-time>
required

Timestamp when the object was last updated.

​
failure_info
TaskFailureInfo · object

Failure information if the task failed, including user-friendly explanation and suggestions