Skip to Content
webagent docs
API reference

Skill runs

Run a skill and read its result.

Open as .md
GET
/v1/skill-runs

Authorization

headerAuthorizationBearer <token>

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

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string
Length1 <= length <= 500
status?array<>
Items1 <= items <= 6
skill?string
Length1 <= length <= 200

Response Body

OK

application/json
  1. response
runs*array<>
next?string
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/skill-runs'
Example Response
{  "runs": [    {      "runId": "string",      "skill": {        "name": "string",        "version": "string"      },      "sessionId": "string",      "status": "running",      "startedAt": 0,      "ms": 0,      "summary": "string",      "counts": {        "property1": 0,        "property2": 0      },      "engineRef": {        "id": "string",        "version": "string",        "name": "string"      }    }  ],  "next": "string"}
GET
/v1/skill-runs/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

application/json
  1. response
runId*string
Match^run_(us|in)_[0-9a-z]{24}$
skill*
sessionId*string
Match^sess_(us|in)_[0-9a-z]{24}$
status*string
Value in"running""passed""failed""error""cancelled""denied"
startedAt*integer
Range0 <= value <= 9007199254740991
ms*|null
summary*string|null
counts*|null
engineRef?
result*|null
hasReport*boolean
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/skill-runs/string'
Example Response
{  "runId": "string",  "skill": {    "name": "string",    "version": "string"  },  "sessionId": "string",  "status": "running",  "startedAt": 0,  "ms": 0,  "summary": "string",  "counts": {    "property1": 0,    "property2": 0  },  "engineRef": {    "id": "string",    "version": "string",    "name": "string"  },  "result": {    "property1": null,    "property2": null  },  "hasReport": true}

The run's HTML report

GET
/v1/skill-runs/{id}/report

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

Redirect to a short-lived URL of report.html

Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/skill-runs/string/report'
Example Response
Empty
GET
/v1/skill-runs/{id}/report.json

The run's test report as JSON (verdict, plain-language summary, failed steps with screenshot links, findings, console errors, failed network calls). running while it has not finished. 404 not_found for an unknown or another project's run. GET /v1/skill-runs/{id}/report is the HTML report

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string
Match^run_(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/skill-runs/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"  ]}

Start a skill run

POST
/v1/skills/{name}/run

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

name*string
Match^[a-z][a-z0-9-]*$

Header Parameters

Idempotency-Key?string

Retry safely: the same key and body replay the first answer.

Length1 <= length <= 255

Request Body

application/json
  1. body
version?string
inputs?
Default{}
engineId?string
Match^eng_(us|in)_[0-9a-z]{24}$
grant?array<>
session?

Response Body

OK

application/json
  1. response
runId*string
Match^run_(us|in)_[0-9a-z]{24}$
sessionId*string
Match^sess_(us|in)_[0-9a-z]{24}$
status*string
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/skills/string/run' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "runId": "string",  "sessionId": "string",  "status": "running"}