Skip to Content
webagent docs
API reference

API keys

List and revoke API keys.

Open as .md

List API keys

GET
/v1/keys

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
keys*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/keys'
Example Response
{  "keys": [    {      "id": "string",      "projectId": "string",      "name": "string",      "prefix": "string",      "role": "admin",      "createdAt": 0,      "lastUsedAt": 0,      "revokedAt": 0    }  ]}

Mint an API key

POST
/v1/keys

Mint an API key (admin, fresh sign-in); the plaintext key is returned once

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100
role?string
Value in"admin""member"
projectId?string
Match^prj_(us|in)_[0-9a-z]{24}$

Response Body

OK

application/json
  1. response
key*string
Match^wa_(us|in)_[A-Za-z0-9_-]{43}$
info*
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/keys' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "key": "string",  "info": {    "id": "string",    "projectId": "string",    "name": "string",    "prefix": "string",    "role": "admin",    "createdAt": 0,    "lastUsedAt": 0,    "revokedAt": 0  }}
DELETE
/v1/keys/{keyId}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

OK

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