API Overview

API capabilities, API authentication, API endpoints, rate limits, API versioning.

API & Integrations

Extend the platform's capabilities by integrating with our powerful API. Build custom integrations, automate workflows, and connect the platform to your existing tools and systems.


API Overview

API Capabilities

The platform provides a comprehensive API that allows you to:

  • Access All Platform Features: Interact with recordings, meetings, transcripts, and AI features programmatically
  • Automate Workflows: Build custom integrations and automation scripts
  • Sync Data: Keep your external systems synchronized with platform data
  • Build Custom Applications: Create custom interfaces and applications on top of the platform
  • Real-time Updates: Receive webhook notifications for important events

API Authentication

The platform supports multiple authentication methods:

  • Bearer Token Authentication: Use access tokens for simple API access
  • OAuth 2.0: Full OAuth 2.0 support for secure third-party integrations
  • API Keys: Long-lived keys for server-to-server communication
  • API Clients: OAuth clients for application-level authentication

All API requests require authentication. Choose the method that best fits your use case.

API Endpoints

The platform provides two main API interfaces:

  • GraphQL API: Flexible, type-safe API for complex queries and mutations
  • REST API: Traditional RESTful endpoints for standard operations

Both APIs provide access to the same data and functionality. Choose based on your preferences and requirements.

Rate Limits

API rate limits help ensure fair usage and system stability:

  • Default Limits: 1000 requests per hour per API key/client
  • Burst Limits: Short bursts of up to 100 requests per minute
  • Rate Limit Headers: All responses include rate limit information
  • Upgrade Options: Higher limits available for enterprise plans

Rate limit information is included in response headers:

  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

Tip: Implement exponential backoff when you hit rate limits to avoid unnecessary retries.

API Versioning

The API uses versioning to ensure stability:

  • Current Version: v1 (default)
  • Version Header: Specify version using X-API-Version header
  • Backward Compatibility: Previous versions remain supported
  • Deprecation Policy: Deprecated features are announced 90 days in advance