Skip to Content
webagent docs
API reference

Settings

Project and organization settings.

Open as .md

Agent settings

GET
/v1/settings/agent

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
maxSteps*integer
Range1 <= value <= 1000
timeoutMinutes*integer
Range1 <= value <= 1440
concurrentSessions*integer
Range1 <= value <= 500
retries*number|number|number
viewport*string
Value in"desktop""desktop-lg""mobile"
region*string
Value in"us""in"
locale*string
Value in"auto""en-US""en-IN"
keepCookies*boolean
allowDownloads*boolean
recordVideo*boolean
siteMode*string
Value in"allow""block"
domains*unknown
approvals*
approvalTimeoutMinutes*number|number|number
approvalChannel*string
Value in"webhook""webhook-email""webhook-slack"
retentionDays*number|number|number|number
maskPii*boolean
shareForImprovement*boolean
processing*
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/agent'
Example Response
{  "maxSteps": 1,  "timeoutMinutes": 1,  "concurrentSessions": 1,  "retries": 0,  "viewport": "desktop",  "region": "us",  "locale": "auto",  "keepCookies": true,  "allowDownloads": true,  "recordVideo": true,  "siteMode": "allow",  "domains": null,  "approvals": {    "payments": true,    "messages": true,    "credentials": true,    "deletes": true,    "legal": true  },  "approvalTimeoutMinutes": 5,  "approvalChannel": "webhook",  "retentionDays": 0,  "maskPii": true,  "shareForImprovement": true,  "processing": {    "models": "off",    "jev": true,    "proxy": true  }}

Replace agent settings (admin)

PUT
/v1/settings/agent

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
maxSteps*integer
Range1 <= value <= 1000
timeoutMinutes*integer
Range1 <= value <= 1440
concurrentSessions*integer
Range1 <= value <= 500
retries*number|number|number
viewport*string
Value in"desktop""desktop-lg""mobile"
region*string
Value in"us""in"
locale*string
Value in"auto""en-US""en-IN"
keepCookies*boolean
allowDownloads*boolean
recordVideo*boolean
siteMode*string
Value in"allow""block"
domains*array<>
Itemsitems <= 500
approvals*
approvalTimeoutMinutes*number|number|number
approvalChannel*string
Value in"webhook""webhook-email""webhook-slack"
retentionDays*number|number|number|number
maskPii*boolean
shareForImprovement*boolean
processing?

Response Body

OK

application/json
  1. response
maxSteps*integer
Range1 <= value <= 1000
timeoutMinutes*integer
Range1 <= value <= 1440
concurrentSessions*integer
Range1 <= value <= 500
retries*number|number|number
viewport*string
Value in"desktop""desktop-lg""mobile"
region*string
Value in"us""in"
locale*string
Value in"auto""en-US""en-IN"
keepCookies*boolean
allowDownloads*boolean
recordVideo*boolean
siteMode*string
Value in"allow""block"
domains*unknown
approvals*
approvalTimeoutMinutes*number|number|number
approvalChannel*string
Value in"webhook""webhook-email""webhook-slack"
retentionDays*number|number|number|number
maskPii*boolean
shareForImprovement*boolean
processing*
Example Request
curl -X PUT 'https://api.us.webagent.lookover.ai/v1/settings/agent' \  -H 'Content-Type: application/json' \  -d '{  "maxSteps": 1,  "timeoutMinutes": 1,  "concurrentSessions": 1,  "retries": 0,  "viewport": "desktop",  "region": "us",  "locale": "auto",  "keepCookies": true,  "allowDownloads": true,  "recordVideo": true,  "siteMode": "allow",  "domains": [    "string"  ],  "approvals": {    "payments": true,    "messages": true,    "credentials": true,    "deletes": true,    "legal": true  },  "approvalTimeoutMinutes": 5,  "approvalChannel": "webhook",  "retentionDays": 0,  "maskPii": true,  "shareForImprovement": true}'
Example Response
{  "maxSteps": 1,  "timeoutMinutes": 1,  "concurrentSessions": 1,  "retries": 0,  "viewport": "desktop",  "region": "us",  "locale": "auto",  "keepCookies": true,  "allowDownloads": true,  "recordVideo": true,  "siteMode": "allow",  "domains": null,  "approvals": {    "payments": true,    "messages": true,    "credentials": true,    "deletes": true,    "legal": true  },  "approvalTimeoutMinutes": 5,  "approvalChannel": "webhook",  "retentionDays": 0,  "maskPii": true,  "shareForImprovement": true,  "processing": {    "models": "off",    "jev": true,    "proxy": true  }}

List MCP servers

GET
/v1/settings/mcp-servers

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
servers*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/mcp-servers'
Example Response
{  "servers": [    {      "id": "string",      "name": "string",      "url": "string",      "transport": "streamable-http",      "auth": "oauth",      "enabled": true,      "status": "connected",      "checkedAt": 0,      "error": "string",      "availability": "all",      "tools": [        {          "name": "string",          "description": "string",          "writes": true,          "policy": "allow"        }      ]    }  ]}

Add an MCP server; its tools are discovered straight away (admin)

POST
/v1/settings/mcp-servers

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100
url*string
Lengthlength <= 2000
transport*string
Value in"streamable-http""sse"
auth*string
Value in"oauth""bearer""headers""none"
token?string
Lengthlength <= 4000
headers?string
Lengthlength <= 8000

Response Body

OK

application/json
  1. response
id*string
name*string
url*string
transport*string
Value in"streamable-http""sse"
auth*string
Value in"oauth""bearer""headers""none"
enabled*boolean
status*string
Value in"connected""error""disabled"
checkedAt*number|null
error*string|null
availability*string
Value in"all""named""keys"
tools*array<>
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/settings/mcp-servers' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "url": "string",  "transport": "streamable-http",  "auth": "oauth"}'
Example Response
{  "id": "string",  "name": "string",  "url": "string",  "transport": "streamable-http",  "auth": "oauth",  "enabled": true,  "status": "connected",  "checkedAt": 0,  "error": "string",  "availability": "all",  "tools": [    {      "name": "string",      "description": "string",      "writes": true,      "policy": "allow"    }  ]}

Change an MCP server (admin)

PATCH
/v1/settings/mcp-servers/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Request Body

application/json
  1. body
enabled?boolean
availability?string
Value in"all""named""keys"

Response Body

OK

application/json
  1. response
id*string
name*string
url*string
transport*string
Value in"streamable-http""sse"
auth*string
Value in"oauth""bearer""headers""none"
enabled*boolean
status*string
Value in"connected""error""disabled"
checkedAt*number|null
error*string|null
availability*string
Value in"all""named""keys"
tools*array<>
Example Request
curl -X PATCH 'https://api.us.webagent.lookover.ai/v1/settings/mcp-servers/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "name": "string",  "url": "string",  "transport": "streamable-http",  "auth": "oauth",  "enabled": true,  "status": "connected",  "checkedAt": 0,  "error": "string",  "availability": "all",  "tools": [    {      "name": "string",      "description": "string",      "writes": true,      "policy": "allow"    }  ]}

Remove an MCP server (admin)

DELETE
/v1/settings/mcp-servers/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

application/json
  1. response
deleted*boolean
Example Request
curl -X DELETE 'https://api.us.webagent.lookover.ai/v1/settings/mcp-servers/string'
Example Response
{  "deleted": true}

Rediscover an MCP server's tools (admin)

POST
/v1/settings/mcp-servers/{id}/reconnect

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

application/json
  1. response
id*string
name*string
url*string
transport*string
Value in"streamable-http""sse"
auth*string
Value in"oauth""bearer""headers""none"
enabled*boolean
status*string
Value in"connected""error""disabled"
checkedAt*number|null
error*string|null
availability*string
Value in"all""named""keys"
tools*array<>
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/settings/mcp-servers/string/reconnect'
Example Response
{  "id": "string",  "name": "string",  "url": "string",  "transport": "streamable-http",  "auth": "oauth",  "enabled": true,  "status": "connected",  "checkedAt": 0,  "error": "string",  "availability": "all",  "tools": [    {      "name": "string",      "description": "string",      "writes": true,      "policy": "allow"    }  ]}

Set one MCP tool's policy (admin)

PATCH
/v1/settings/mcp-servers/{id}/tools/{tool}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string
Match^mcp_(us|in)_[0-9a-z]{24}$
tool*string
Length1 <= length <= 200

Request Body

application/json
  1. body
policy*string
Value in"allow""ask""block"

Response Body

OK

application/json
  1. response
id*string
name*string
url*string
transport*string
Value in"streamable-http""sse"
auth*string
Value in"oauth""bearer""headers""none"
enabled*boolean
status*string
Value in"connected""error""disabled"
checkedAt*number|null
error*string|null
availability*string
Value in"all""named""keys"
tools*array<>
Example Request
curl -X PATCH 'https://api.us.webagent.lookover.ai/v1/settings/mcp-servers/string/tools/string' \  -H 'Content-Type: application/json' \  -d '{  "policy": "allow"}'
Example Response
{  "id": "string",  "name": "string",  "url": "string",  "transport": "streamable-http",  "auth": "oauth",  "enabled": true,  "status": "connected",  "checkedAt": 0,  "error": "string",  "availability": "all",  "tools": [    {      "name": "string",      "description": "string",      "writes": true,      "policy": "allow"    }  ]}

Model routing settings

GET
/v1/settings/model-routing

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
routes*
maxTokensPerRun*integer
Range1000 <= value <= 10000000
monthlySpendCapUsd*|null
fallbackToManagedKeys*boolean
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/model-routing'
Example Response
{  "routes": {    "planner": "string",    "actions": "string",    "extraction": "string",    "fallback": "string"  },  "maxTokensPerRun": 1000,  "monthlySpendCapUsd": 0,  "fallbackToManagedKeys": true}

Change model routing (admin)

PATCH
/v1/settings/model-routing

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
routes?
maxTokensPerRun?integer
Range1000 <= value <= 10000000
monthlySpendCapUsd?|null
fallbackToManagedKeys?boolean

Response Body

OK

application/json
  1. response
routes*
maxTokensPerRun*integer
Range1000 <= value <= 10000000
monthlySpendCapUsd*|null
fallbackToManagedKeys*boolean
Example Request
curl -X PATCH 'https://api.us.webagent.lookover.ai/v1/settings/model-routing' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "routes": {    "planner": "string",    "actions": "string",    "extraction": "string",    "fallback": "string"  },  "maxTokensPerRun": 1000,  "monthlySpendCapUsd": 0,  "fallbackToManagedKeys": true}

List available models

GET
/v1/settings/models

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
models*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/models'
Example Response
{  "models": [    {      "id": "string",      "label": "string",      "provider": "anthropic"    }  ]}

List model providers

GET
/v1/settings/providers

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
providers*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/providers'
Example Response
{  "providers": [    {      "id": "anthropic",      "name": "string",      "description": "string",      "keyPlaceholder": "string",      "needsBaseUrl": true,      "connected": true,      "maskedKey": "string",      "baseUrl": "string",      "addedAt": 0    }  ]}

Disconnect a model provider (admin)

DELETE
/v1/settings/providers/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string
Value in"anthropic""openai""google""custom"

Response Body

OK

application/json
  1. response
id*string
Value in"anthropic""openai""google""custom"
name*string
description*string
keyPlaceholder*string
needsBaseUrl*boolean
connected*boolean
maskedKey*string|null
baseUrl*string|null
addedAt*number|null
Example Request
curl -X DELETE 'https://api.us.webagent.lookover.ai/v1/settings/providers/anthropic'
Example Response
{  "id": "anthropic",  "name": "string",  "description": "string",  "keyPlaceholder": "string",  "needsBaseUrl": true,  "connected": true,  "maskedKey": "string",  "baseUrl": "string",  "addedAt": 0}

Connect a model provider (admin)

PUT
/v1/settings/providers/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string
Value in"anthropic""openai""google""custom"

Request Body

application/json
  1. body
apiKey*string
Length8 <= length <= 500
baseUrl?string
Lengthlength <= 500

Response Body

OK

application/json
  1. response
id*string
Value in"anthropic""openai""google""custom"
name*string
description*string
keyPlaceholder*string
needsBaseUrl*boolean
connected*boolean
maskedKey*string|null
baseUrl*string|null
addedAt*number|null
Example Request
curl -X PUT 'https://api.us.webagent.lookover.ai/v1/settings/providers/anthropic' \  -H 'Content-Type: application/json' \  -d '{  "apiKey": "stringst"}'
Example Response
{  "id": "anthropic",  "name": "string",  "description": "string",  "keyPlaceholder": "string",  "needsBaseUrl": true,  "connected": true,  "maskedKey": "string",  "baseUrl": "string",  "addedAt": 0}

Test a model provider's key (admin)

POST
/v1/settings/providers/{id}/test

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string
Value in"anthropic""openai""google""custom"

Response Body

OK

application/json
  1. response
ok*boolean
message*string
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/settings/providers/anthropic/test'
Example Response
{  "ok": true,  "message": "string"}

List webhook endpoints

GET
/v1/settings/webhooks

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
webhooks*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/webhooks'
Example Response
{  "webhooks": [    {      "id": "string",      "url": "string",      "active": true,      "events": [        "run.started"      ],      "maskedSecret": "string"    }  ]}

Add a webhook endpoint; the signing secret is returned once (admin)

POST
/v1/settings/webhooks

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
url*string
Lengthlength <= 2000
events*array<>
Items1 <= items

Response Body

OK

application/json
  1. response
id*string
url*string
active*boolean
events*array<>
maskedSecret*string
secret*string
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/settings/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "string",  "events": [    "run.started"  ]}'
Example Response
{  "id": "string",  "url": "string",  "active": true,  "events": [    "run.started"  ],  "maskedSecret": "string",  "secret": "string"}

Change a webhook endpoint (admin)

PATCH
/v1/settings/webhooks/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Request Body

application/json
  1. body
events?array<>
Items1 <= items
active?boolean

Response Body

OK

application/json
  1. response
id*string
url*string
active*boolean
events*array<>
maskedSecret*string
Example Request
curl -X PATCH 'https://api.us.webagent.lookover.ai/v1/settings/webhooks/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "url": "string",  "active": true,  "events": [    "run.started"  ],  "maskedSecret": "string"}

Remove a webhook endpoint (admin)

DELETE
/v1/settings/webhooks/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

application/json
  1. response
deleted*boolean
Example Request
curl -X DELETE 'https://api.us.webagent.lookover.ai/v1/settings/webhooks/string'
Example Response
{  "deleted": true}

Recent deliveries of a webhook endpoint

GET
/v1/settings/webhooks/{id}/deliveries

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Query Parameters

limit?integer
Range1 <= value <= 100
Default10
state?string
Default"all"
Value in"all""dead"

Response Body

OK

application/json
  1. response
deliveries*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/settings/webhooks/string/deliveries'
Example Response
{  "deliveries": [    {      "id": "string",      "endpointId": "string",      "event": "run.started",      "runId": "string",      "status": -9007199254740991,      "error": "string",      "sentAt": 0,      "attempt": -9007199254740991,      "nextAttemptAt": 0    }  ]}

Roll a webhook's signing secret (admin)

POST
/v1/settings/webhooks/{id}/roll-secret

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

application/json
  1. response
id*string
url*string
active*boolean
events*array<>
maskedSecret*string
secret*string
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/settings/webhooks/string/roll-secret'
Example Response
{  "id": "string",  "url": "string",  "active": true,  "events": [    "run.started"  ],  "maskedSecret": "string",  "secret": "string"}

Send a test ping; answers the latest delivery or null (admin)

POST
/v1/settings/webhooks/{id}/test

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

application/json
  1. response
id*string
endpointId*string
event*string
Value in"run.started""run.completed""run.failed""run.changed""session.live""session.captcha""test.ping"
runId*string|null
status*integer
Range-9007199254740991 <= value <= 9007199254740991
error*string|null
sentAt*number
attempt*integer
Range-9007199254740991 <= value <= 9007199254740991
nextAttemptAt*number|null
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/settings/webhooks/string/test'
Example Response
{  "id": "string",  "endpointId": "string",  "event": "run.started",  "runId": "string",  "status": -9007199254740991,  "error": "string",  "sentAt": 0,  "attempt": -9007199254740991,  "nextAttemptAt": 0}

Sessions

Create, inspect, control and stop browser sessions.

Site access

Allow headers and signed access for your own sites.