API Keys

Create and list authentication keys.

API keys authenticate every request. The full secret is returned only once, at creation.

List API keys

Returns key metadata only — never the secret.

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

Create an API key

const created = await voice.apiKeys.create({
  name: "Production server",
  scopes: ["agents:write", "calls:write"],
});
// Store created.secret now — it is shown only once.
created = client.create_api_key(
    name="Production server",
    scopes=["agents:write", "calls:write"],
)
# Store created["secret"] now — it is shown only once.

Parameters

FieldTypeRequiredDescription
namestringYesFriendly label to identify the key.
scopesstring[]YesPermission scopes granted to the key.

The secret field is only present in the create response. Store it securely — it cannot be retrieved again.

On this page