Skip to main content
POST
/
tasks
cURL
curl --request POST \
  --url 'https://platform.abundant.ai/api/v1/tasks' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetUrl": "https://remote.browser.com/target",
  "description": "Post about Project Papaya on Hacker News",
  "title": "Post on Hacker News",
  "context": {
    "history": [
      {
        "user": "Create a post about Project Papaya on Hacker News",
        "assistant": "Lets navigate to Hacker News and create a post about Project Papaya. I will guide you through the process."
      }
    ]
  }
}'
{
  "id": "<string>",
  "status": "<string>",
  "targetUrl": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "taskThreadId": "<string>",
  "title": "<string>",
  "type": "WEB_INTERVENTION",
  "context": {},
  "feedback": {}
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
targetUrl
string<uri>
required

The VNC URL with the browser session to be tele-operated on.

​
description
string
required

Description for the task.

​
title
string

Title of the task.

​
context
object

Additional context for the task.

​
type
enum<string>
default:WEB_INTERVENTION

Type of the task.

Available options:
AUDIO_TRANSCRIPTION,
CUSTOMER_SUPPORT,
DATA_ENTRY,
DOCUMENT_REVIEW,
MEETING_SCHEDULING,
OTHER,
WEB_INTERVENTION
​
notifyUrl
string<uri>

The URL to send notifications to.

​
notifyMethod
enum<string>
default:POLL

The method for notifications.

Available options:
WEBHOOK,
POLL
​
metadata
object

Additional metadata for the task.

​
threadId
string

ID of the task thread to append the task to.

​
notify
boolean
default:true

Whether to notify the tasker.

​
assignTo
string

UserRole ID of the tasker to assign the task to. Get your UserRole ID from the Abundant dashboard.

Response

Task created successfully

​
id
string
required
​
status
string
required
​
targetUrl
string<uri>
required
​
description
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
metadata
object
required
​
taskThreadId
string
required
​
title
string | null
​
type
enum<string>
default:WEB_INTERVENTION
Available options:
AUDIO_TRANSCRIPTION,
CUSTOMER_SUPPORT,
DATA_ENTRY,
DOCUMENT_REVIEW,
MEETING_SCHEDULING,
OTHER,
WEB_INTERVENTION
​
context
object
​
feedback
object