API Clients

API clients provide OAuth 2.0 authentication for applications. Use API clients when building integrations that require user authorization or when you need fine-grained permission control.

Creating API Clients

Client Creation

Create a new API client:

1. Navigate to Settings → API Clients
2. Click "Create API Client"
3. Enter a descriptive name for your client
4. Optionally add a description (up to 1000 characters)
5. Configure expiration date (optional)
6. Select scopes/permissions (optional)
7. Click "Create"

Client Credentials

After creation, you'll receive:

• Client ID: Public identifier for your client (always visible)
• Client Secret: Secret key for authentication (shown only once)

Important: Save your client secret immediately. It cannot be retrieved later. If lost, you'll need to rotate the secret.

Example Client Credentials:

Client ID: abc123xyz789

Client Secret: sk_live_51HjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQrStUvWxYz

Client Configuration

Configure your API client settings:

1. Open the API client details page
2. Name: Update the client name
3. Description: Modify the description
4. Expiration: Set or update expiration date
5. Scopes: Configure OAuth scopes and permissions
6. Rate Limits: View and configure rate limits
7. Metadata: Add custom metadata (JSON format)
8. Save changes

Scopes and Permissions

Configure what your API client can access:

• Read Access: Read recordings, meetings, transcripts
• Write Access: Create and update recordings, meetings
• Delete Access: Delete recordings and meetings
• Admin Access: Full administrative access
• Custom Scopes: Define custom permissions for your use case

Select only the scopes your application needs to follow the principle of least privilege.

Expiration Settings

Set expiration dates for API clients:

• No Expiration: Client remains active indefinitely (default)
• Custom Expiration: Set a specific expiration date
• Automatic Deactivation: Client automatically deactivates after expiration
• Renewal: Extend expiration before it expires

Security Best Practice: Set expiration dates for API clients, especially for testing or temporary integrations.