Skip to main content
POST
Link browsers to a task

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Task ID

Body

application/json

Request body for linking browsers to a task.

session_ids
string[]
required

IDs of browsers to link. Each must belong to the task's project; deleted browsers can be linked. Browsers already linked are ignored. A task can have at most 100 linked browsers.

Required array length: 1 - 100 elements
Minimum string length: 1

Response

Task with its linked browsers

A goal an agent works toward. Reports are submitted against a task, and browsers can be linked to it. Tasks are immutable apart from added browser links.

created_at
string<date-time>
required

When the task was created

description
string
required

What the task is meant to accomplish

id
string
required

Unique identifier for the task

metadata
object
required

Caller-defined string key-value pairs for grouping and filtering tasks, such as a user or thread ID. At most 20 keys; keys are 1-64 characters, values at most 256 characters, and keys and values together at most 4 KB.

Example:
session_ids
string[]
required

IDs of browsers linked to the task, oldest link first. Linked browsers may since have been deleted.

started_at
string<date-time>
required

When work on the task started

target_website
string | null

Hostname of the website the task targets