> ## Documentation Index
> Fetch the complete documentation index at: https://docs.livefaces.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API keys

> Create scoped server credentials and manage their access.

## Create a key in the console

1. Select the correct organization and open **API keys → Create API key**.
2. Enter a name, select the needed scopes, and optionally set an expiration date.
3. Click **Create key** and save the revealed secret securely. It is shown only once.

If prompted for recent authentication, open **Account settings → Sensitive access → Refresh access**, then retry the action.

| Your application needs to… | Scope |
| - | - |
| Create voice sessions | `sessions:create` |
| Start published workflows | `workflows:run` |
| Read session state, refresh tokens, or read transcripts | `sessions:read` |
| End sessions | `sessions:delete` |

For example, a workflow integration that starts, reads, and ends conversations needs `workflows:run`, `sessions:read`, and `sessions:delete`.

## Use the key from your server

Store it in a server environment variable or secret manager and send it as `Authorization: Bearer …`. Keep it out of browser bundles, public environment variables, URLs, and logs.

Check the key's organization, scopes, and expiry:

```bash theme={null}
curl 'https://api.livefaces.ai/v1/auth/api-key' \
  --header "Authorization: Bearer $LIVEFACES_API_KEY"
```

## Edit, rotate, or revoke

The console shows each key's status, prefix, scopes, and last use. **Edit** changes its name, scopes, or expiration. **Revoke** immediately prevents new authenticated requests with that key.

To rotate, create a replacement, deploy it to your server, verify new sessions work, and then revoke the previous key. Plan existing-session access before rotation: session reads and end requests require the key that created that session. Revoking a key is not a substitute for explicitly ending its sessions.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.