Whereby

Whereby is an embeddable video API plus standalone meetings product that lets developers add browser-based, no-download video calls to their apps with a few lines of code or build deeply customized experiences via SDKs. The REST API at api.whereby.dev/v1 covers meetings, rooms, recordings, transcriptions, summaries, and insights.

2 APIs 12 Features

VideoCommunicationsReal-TimeWebRTCEmbeddedMeetingsCollaboration

APIs

Whereby REST API

Bearer-authenticated REST API for creating meeting rooms, managing live sessions, retrieving recordings, transcriptions, summaries, and pulling usage insights. Base URL https://...

Whereby Webhooks

Outbound webhook notifications for room and session lifecycle events including client join/leave, knock, session start/end, recording finished, transcription started/finished/fa...

Collections

Whereby REST API

OPEN

GraphQL

Whereby GraphQL Schema

This is a conceptual GraphQL schema for the Whereby embeddable video meetings API. Whereby provides a REST API at `https://api.whereby.dev/v1` for creating and managing meeting ...

GRAPHQL

Pricing Plans

Whereby Plans Pricing

1 plans

PLANS

Rate Limits

Whereby Rate Limits

2 limits

RATE LIMITS

FinOps

Whereby Finops

FINOPS

Features

Embeddable video calls via iframe, Web Component, or React Browser SDK

Native Android and iOS SDKs

REST API for programmatic meeting and room creation

Cloud recording with retrieval via API

AI-generated transcriptions and meeting summaries

Breakout groups, in-call chat, and file sharing

Pre-call device and connectivity checks

Webhooks for room, session, recording, transcription, and assistant events

Whereby-Signature HMAC verification on webhook deliveries

Point-based rate limiting (100/min Build, 1000/min Enterprise)

GDPR and ISO 27001 compliance, optional HIPAA configuration

Global mesh network for low-latency media

Event Specifications

Review

ASYNCAPI

Resources

Documentation

APIReference

GettingStarted

Authentication

TermsOfService

PrivacyPolicy

GitHubOrganization

GitHubOrganization

WebComponent

Sources

opencollection: 1.0.0
info:
  name: Whereby REST API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: List meetings
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/meetings
  docs: List meetings
- info:
    name: Create a meeting
    type: http
  http:
    method: POST
    url: https://api.whereby.dev/v1/meetings
    body:
      type: json
      data: '{}'
  docs: Creates a transient room that is available between creation and an hour after the given endDate.
- info:
    name: Retrieve a meeting
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/meetings/:meetingId
    params:
    - name: meetingId
      value: ''
      type: path
  docs: Retrieve a meeting
- info:
    name: Delete a meeting
    type: http
  http:
    method: DELETE
    url: https://api.whereby.dev/v1/meetings/:meetingId
    params:
    - name: meetingId
      value: ''
      type: path
  docs: Delete a meeting
- info:
    name: Upload a logo for a room theme
    type: http
  http:
    method: PUT
    url: https://api.whereby.dev/v1/rooms/:roomName/theme/logo
    params:
    - name: roomName
      value: ''
      type: path
    body:
      type: multipart-form
      data:
      - name: file
        type: text
        value: ''
  docs: Upload a logo for a room theme
- info:
    name: Update theme tokens for a room
    type: http
  http:
    method: PUT
    url: https://api.whereby.dev/v1/rooms/:roomName/theme/tokens
    params:
    - name: roomName
      value: ''
      type: path
    body:
      type: json
      data: '{}'
  docs: Update theme tokens for a room
- info:
    name: Update room background image
    type: http
  http:
    method: PUT
    url: https://api.whereby.dev/v1/rooms/:roomName/theme/room-background
    params:
    - name: roomName
      value: ''
      type: path
    body:
      type: multipart-form
      data:
      - name: file
        type: text
        value: ''
  docs: Update room background image
- info:
    name: Update room knock page background image
    type: http
  http:
    method: PUT
    url: https://api.whereby.dev/v1/rooms/:roomName/theme/room-knock-page-background
    params:
    - name: roomName
      value: ''
      type: path
    body:
      type: multipart-form
      data:
      - name: file
        type: text
        value: ''
  docs: Update room knock page background image
- info:
    name: List recordings
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/recordings
  docs: List recordings
- info:
    name: Retrieve a recording
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/recordings/:recordingId
    params:
    - name: recordingId
      value: ''
      type: path
  docs: Retrieve a recording
- info:
    name: Delete a recording
    type: http
  http:
    method: DELETE
    url: https://api.whereby.dev/v1/recordings/:recordingId
    params:
    - name: recordingId
      value: ''
      type: path
  docs: Delete a recording
- info:
    name: Get an access link for a recording
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/recordings/:recordingId/access-link
    params:
    - name: recordingId
      value: ''
      type: path
  docs: Get an access link for a recording
- info:
    name: Bulk delete recordings
    type: http
  http:
    method: POST
    url: https://api.whereby.dev/v1/recordings/bulk-delete
    body:
      type: json
      data: '{}'
  docs: Bulk delete recordings
- info:
    name: List transcriptions
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/transcriptions
  docs: List transcriptions
- info:
    name: Create a transcription
    type: http
  http:
    method: POST
    url: https://api.whereby.dev/v1/transcriptions
    body:
      type: json
      data: '{}'
  docs: Create a transcription
- info:
    name: Retrieve a transcription
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/transcriptions/:transcriptionId
    params:
    - name: transcriptionId
      value: ''
      type: path
  docs: Retrieve a transcription
- info:
    name: Delete a transcription
    type: http
  http:
    method: DELETE
    url: https://api.whereby.dev/v1/transcriptions/:transcriptionId
    params:
    - name: transcriptionId
      value: ''
      type: path
  docs: Delete a transcription
- info:
    name: Get an access link for a transcription
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/transcriptions/:transcriptionId/access-link
    params:
    - name: transcriptionId
      value: ''
      type: path
  docs: Get an access link for a transcription
- info:
    name: Bulk delete transcriptions
    type: http
  http:
    method: POST
    url: https://api.whereby.dev/v1/transcriptions/bulk-delete
    body:
      type: json
      data: '{}'
  docs: Bulk delete transcriptions
- info:
    name: List meeting summaries
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/summaries
  docs: List meeting summaries
- info:
    name: Create a meeting summary
    type: http
  http:
    method: POST
    url: https://api.whereby.dev/v1/summaries
    body:
      type: json
      data: '{}'
  docs: Create a meeting summary
- info:
    name: Retrieve a summary
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/summaries/:summaryId
    params:
    - name: summaryId
      value: ''
      type: path
  docs: Retrieve a summary
- info:
    name: Delete a summary
    type: http
  http:
    method: DELETE
    url: https://api.whereby.dev/v1/summaries/:summaryId
    params:
    - name: summaryId
      value: ''
      type: path
  docs: Delete a summary
- info:
    name: Insights for rooms
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/insights/rooms
  docs: Insights for rooms
- info:
    name: Insights for room sessions
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/insights/room-sessions
  docs: Insights for room sessions
- info:
    name: Insights for participants
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/insights/participants
  docs: Insights for participants
- info:
    name: Insights for a specific participant
    type: http
  http:
    method: GET
    url: https://api.whereby.dev/v1/insights/participant
  docs: Insights for a specific participant
bundled: true