Skip to main content
POST
/
v1
/
task
Create Task
curl --request POST \
  --url https://api.anchorbrowser.io/v1/task \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "name": "web-scraper",
  "language": "typescript"
}'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "latestVersion": "<string>",
    "code": "<string>",
    "language": "typescript",
    "browserConfiguration": {
      "initial_url": "<string>",
      "recording": {
        "active": true
      },
      "proxy": {
        "active": true,
        "type": "anchor_proxy",
        "country_code": "af",
        "region": "<string>",
        "city": "<string>"
      },
      "timeout": {
        "max_duration": 123,
        "idle_timeout": 123
      },
      "live_view": {
        "read_only": true
      }
    },
    "deleted": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

anchor-api-key
string
header
required

API key passed in the header

Body

application/json
name
string
required

Task name (letters, numbers, hyphens, and underscores only)

Required string length: 1 - 255
language
enum<string>
required

Programming language for the task

Available options:
typescript
code
string

Base64 encoded task code (optional)

description
string

Optional description of the task

Maximum length: 1000
browserConfiguration
object

Browser configuration for task execution

Response

Task created or updated successfully

data
object
I