VoiceLayerDocs
Dashboard

Read effective public access

GET
/v1/public-access/effective

Resolves what a session on a website key gets right now: whether it is open, why not when it is not, each cap, whether the bot check applies, and which level (platform, plan, workspace, agent or key) decided each value. Levels only tighten: a cap is the lowest of them and any "off" wins.

Requires an API key with the public_access:read scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Query Parameters

keyId*string

The publishable website key to resolve.

Length1 <= length <= 200

Response Body

The values a session on this key gets now, and the level that set each

application/json
  1. response
keyId*string
open*boolean
offReason*|
Value in"operator_off""workspace_off""agent_off""binding_not_enabled""binding_agent_mismatch""no_challenge_keys""key_unbound"null
sessionsPerDay?integer
concurrentSessions?integer
perIpPerHour?integer
maxCallMinutes?integer
botCheck?string
Value in"on""off"
challengeKeySource?||null
sources?
botCheckOptional?boolean
ceilings?
botOffCeilings?
Example Request
curl "https://api.vlayers.ai/v1/public-access/effective?keyId=$WEBSITE_KEY_ID" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "keyId": "key_9b3d42",  "open": true,  "offReason": null,  "sessionsPerDay": 50,  "concurrentSessions": 2,  "perIpPerHour": 3,  "maxCallMinutes": 3,  "botCheck": "on",  "challengeKeySource": {    "kind": "connection",    "connectionId": "0192f5c3-7a8b-7cad-9e2f-3a4b5c6d7e89"  },  "sources": {    "enabled": "binding",    "sessionsPerDay": "operator",    "concurrentSessions": "binding",    "perIpPerHour": "operator",    "maxCallMinutes": "operator",    "botCheck": "operator",    "challengeKeySource": "workspace"  },  "botCheckOptional": false,  "ceilings": {    "sessionsPerDay": 50,    "concurrentSessions": 3,    "perIpPerHour": 3,    "maxCallMinutes": 3  },  "botOffCeilings": {    "sessionsPerDay": 10,    "concurrentSessions": 1,    "perIpPerHour": 1  }}