Read the deployment and tenant capability map for this workspace

GET

/v1/workspace-capabilities

const url = 'https://api.vocapable.com/v1/workspace-capabilities';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/workspace-capabilities \
  --header 'Authorization: Bearer <token>'

Return one fresh readiness map without mutating a workspace or reserving capacity.

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceCapabilities

The complete, fresh capability map used by the customer portal.

object

generated_at

required

Generated At

string format: date-time

capabilities

required

Capabilities

Array<object>

>= 6 items <= 6 items

WorkspaceCapability

One finite capability with the current reason it cannot be used, if any.

needs_setup names something the tenant or its developer can complete. unavailable names a deployment/service condition; the portal should explain it plainly and avoid presenting a setup CTA that cannot succeed. ready always carries no blockers.

object

key

required

Key

string

Allowed values: browser_voice_test text_chat_test phone_test_call voice_preview calendar_booking guided_setup

state

required

State

string

Allowed values: ready needs_setup unavailable

blockers

Blockers

Array<string>

Allowed values: account_agreements_required agents_write_scope_required calls_write_scope_required runtime_not_configured browser_runtime_not_configured fleet_placement_not_configured agent_chat_not_configured assisted_setup_not_configured voice_catalog_empty verified_test_number_required test_call_daily_cap_reached telephony_account_required telephony_account_unverified telephony_worker_unavailable calendar_integration_not_configured calendar_connection_required calendar_connection_reconnect_required

Example

{
  "capabilities": [
    {
      "key": "browser_voice_test",
      "state": "ready",
      "blockers": [
        "account_agreements_required"
      ]
    }
  ]
}