Skip to Content
webagent docs
API reference

Tasks

Goal tasks that run in a session.

Open as .md

The goal tasks run in a session, newest first

GET
/v1/sessions/{id}/tasks

The goal tasks run in a session, newest first (at most 200). 404 not_found for an unknown or another project's session

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

id*string
Match^sess_(us|in)_[0-9a-z]{24}$

Response Body

OK

application/json
  1. response
tasks*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/sessions/string/tasks'
Example Response
{  "tasks": [    {      "id": "string",      "sessionId": "string",      "goal": "string",      "startedBy": {        "kind": "key",        "id": "string",        "name": "string"      },      "engineRef": {        "id": "string",        "version": "string",        "name": "string"      },      "mode": "auto",      "waiting": {        "id": "string",        "kind": "choice",        "text": "string",        "options": [          {            "id": "string",            "label": "string",            "detail": "string",            "recommended": true          }        ],        "allowText": true      },      "progress": [        {          "at": 0,          "text": "string"        }      ],      "exchanges": [        {          "question": {            "id": "string",            "kind": "choice",            "text": "string",            "options": [              {                "id": "string",                "label": "string",                "detail": "string",                "recommended": true              }            ],            "allowText": true          },          "answer": {            "optionId": "string",            "text": "string",            "by": {              "kind": "key",              "id": "string",              "name": "string"            },            "at": 0          }        }      ],      "status": "running",      "ok": true,      "stoppedBy": "done",      "limit": "maxSteps",      "reason": "string",      "answer": "string",      "steps": [        {          "op": "string",          "ref": "string",          "provider": "string",          "ok": true,          "ms": 0,          "costMicros": 0,          "error": "string"        }      ],      "costMicros": 0,      "ms": 0,      "refusedNavigations": 0,      "startedAt": "2019-08-24T14:15:22Z",      "finishedAt": "2019-08-24T14:15:22Z"    }  ]}

The project's goal tasks across sessions, newest first

GET
/v1/tasks

The project's goal tasks across sessions, newest first (at most 200); sessionId narrows to one session

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Query Parameters

sessionId?string
Match^sess_(us|in)_[0-9a-z]{24}$

Response Body

OK

application/json
  1. response
tasks*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/tasks'
Example Response
{  "tasks": [    {      "id": "string",      "sessionId": "string",      "goal": "string",      "startedBy": {        "kind": "key",        "id": "string",        "name": "string"      },      "engineRef": {        "id": "string",        "version": "string",        "name": "string"      },      "mode": "auto",      "waiting": {        "id": "string",        "kind": "choice",        "text": "string",        "options": [          {            "id": "string",            "label": "string",            "detail": "string",            "recommended": true          }        ],        "allowText": true      },      "progress": [        {          "at": 0,          "text": "string"        }      ],      "exchanges": [        {          "question": {            "id": "string",            "kind": "choice",            "text": "string",            "options": [              {                "id": "string",                "label": "string",                "detail": "string",                "recommended": true              }            ],            "allowText": true          },          "answer": {            "optionId": "string",            "text": "string",            "by": {              "kind": "key",              "id": "string",              "name": "string"            },            "at": 0          }        }      ],      "status": "running",      "ok": true,      "stoppedBy": "done",      "limit": "maxSteps",      "reason": "string",      "answer": "string",      "steps": [        {          "op": "string",          "ref": "string",          "provider": "string",          "ok": true,          "ms": 0,          "costMicros": 0,          "error": "string"        }      ],      "costMicros": 0,      "ms": 0,      "refusedNavigations": 0,      "startedAt": "2019-08-24T14:15:22Z",      "finishedAt": "2019-08-24T14:15:22Z"    }  ]}

The goal task's report as JSON

GET
/v1/tasks/{id}/report.json

The goal task's report as JSON. A task has no assertions: pass means the agent says it is done. 404 not_found for an unknown or another project's task

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

id*string
Match^tsk_(us|in)_[0-9a-z]{24}$

Response Body

OK

application/json
  1. response
id*|
kind*string
Value in"task""skill_run"
sessionId*string
Match^sess_(us|in)_[0-9a-z]{24}$
name*string
Lengthlength <= 300
verdict*string
Value in"pass""fail""error""running"
outcome*string
Lengthlength <= 40
summary*string
Lengthlength <= 1500
url?string
Lengthlength <= 2000
finalUrl?string
Lengthlength <= 2000
startedAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
endedAt?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
durationMs?number
Range0 <= value
counts*
steps*array<>
Itemsitems <= 50
findings*array<>
Itemsitems <= 30
consoleErrors*array<>
Itemsitems <= 15
networkFailures*array<>
Itemsitems <= 20
evidence*
notes*array<>
Itemsitems <= 8
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/tasks/string/report.json'
Example Response
{  "id": "string",  "kind": "task",  "sessionId": "string",  "name": "string",  "verdict": "pass",  "outcome": "string",  "summary": "string",  "url": "string",  "finalUrl": "string",  "startedAt": "2019-08-24T14:15:22Z",  "endedAt": "2019-08-24T14:15:22Z",  "durationMs": 0,  "counts": {    "steps": 0,    "failedSteps": 0,    "findings": 0,    "consoleErrors": 0,    "networkFailures": 0  },  "steps": [    {      "index": 0,      "title": "string",      "kind": "string",      "status": "pass",      "error": "string",      "ms": 0,      "screenshotUrl": "string"    }  ],  "findings": [    {      "rule": "string",      "severity": "info",      "title": "string",      "url": "string",      "fix": "string",      "detail": "string"    }  ],  "consoleErrors": [    {      "source": "console",      "text": "string",      "url": "string"    }  ],  "networkFailures": [    {      "kind": "http_error",      "method": "string",      "url": "string",      "status": -9007199254740991,      "error": "string"    }  ],  "evidence": {    "reportPath": "string",    "reportSignedUrl": "string",    "recordingPath": "string",    "logsPath": "string",    "urlsExpireAt": "2019-08-24T14:15:22Z"  },  "notes": [    "string"  ]}

Skills

Skills installed for the project.

Team

Members, roles and invitations.