Skip to main content

When to Reference This

Use this page when you’re:
  • Designing systems with privacy requirements
  • Choosing storage and retention policies
  • Implementing consent workflows
  • Securing API access patterns

Quick Example

Next Steps

Capture Session

Secure desktop capture patterns

API Reference

API key management

Storage Modes

Persistent Storage (Default)

Media and derived data are stored for retrieval and search:
Use for:
  • Video archives and libraries
  • Searchable knowledge bases
  • Long-term agent memory

Data Minimization

Choose capture channels deliberately and retain only the media your workflow needs. The released RTStream V2 indexing flow requires store=True when a continuous VLM output will be indexed.
Use for:
  • Live monitoring dashboards with deliberate channel selection
  • Privacy-sensitive contexts that minimize captured inputs
  • Workflows with documented retention controls

Retention Patterns

Define Your Retention Policy

  • Document what is captured, why it is retained, and who can access it
  • Use the capture SDK’s per-channel store control to minimize collection
  • Confirm product- and account-specific retention controls before making guarantees to users

Manual Deletion


API Key Security

Key Management

Best practices:
  • Never embed keys in client applications
  • Use environment variables
  • Rotate keys periodically
  • Use separate keys for dev/prod
Manage API keys through the VideoDB platform controls. The released Python and Node SDKs do not expose API-key creation, listing, or deletion methods; see the Authentication API reference for the supported platform workflow.

Client Token Pattern

For desktop and mobile clients, use short-lived tokens instead of API keys:
Why this matters:
  • Tokens expire automatically
  • Tokens have limited scope
  • Compromised tokens have limited blast radius
  • API key never leaves your backend

Before capturing screen, mic, or camera:

Data Subject Access

Map consent and capture records to your own user identity, then implement authenticated access and deletion-request workflows in your application. Python can list capture sessions by collection and status, but it has no end_user_id filter and CaptureSession.delete() is not available. Keep the user-to-resource mapping and deletion orchestration in your application until a supported lifecycle API is available.

Network Security

HTTPS

All API communication uses HTTPS. No configuration needed.

Webhook Security

Verify webhook payloads to prevent spoofing:

Compliance Considerations

GDPR

  • Implement data access endpoints
  • Implement deletion endpoints
  • Document data processing purposes
  • Minimize stored channels when storage is not needed

HIPAA

  • Minimize captured and stored data for sensitive content
  • Implement strict access controls
  • Audit all data access
  • Consider on-premise deployment for PHI

SOC 2

  • VideoDB maintains SOC 2 compliance
  • Implement access logging
  • Use separate keys per environment
  • Regular key rotation

Best Practices Summary

  1. Never expose API keys - Use client tokens for untrusted clients
  2. Minimize collection - Only persist data when needed
  3. Implement deletion - Honor data deletion requests
  4. Short token lifetimes - 10-15 minutes for desktop capture
  5. Audit access - Log who accesses what data
  6. Encrypt at rest - VideoDB encrypts stored data
  7. Get consent - Always get user permission before capture