Workspace & API Keys

Overview

A high-level summary of active calls, live agents, tools, schedules, webhooks, API keys, and wallet balance.

const overview = await voice.overview.get();

overview = client.overview()

Wallet balance, plan, and auto top-up settings. See Billing & Wallet for top-ups, transactions, and payments.

const billing = await voice.billing.get();

billing = client.billing()

Returns key metadata only — secrets are never shown after creation, just a masked secretHint.

const keys = await voice.apiKeys.get();

keys = client.api_keys()

The response includes rawKey — the full secret — exactly once. Store it securely; it cannot be retrieved again.

const created = await voice.apiKeys.create({
  name: "Production server",
  scopes: [],
});
// Store created.rawKey now — it is shown only once.

created = client.create_api_key(
    name="Production server",
    scopes=[],
)
# Store created["rawKey"] now — it is shown only once.

Field	Type	Required	Description
`name`	string	Yes	Friendly label to identify the key.
`scopes`	string[]	Yes	Permission scopes granted to the key (empty array for default access).