Recall.ai

https://docs.recall.ai
Admin
Recall.ai provides a universal API for meeting bots and conversation data, enabling developers to...
Tokens:482,541
Snippets:3,286
Trust Score:9.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### SDK Initialization and Usage

Source: https://docs.recall.ai/v1.11/docs/desktop-sdk

Example demonstrating how to initialize the Recall.ai Desktop SDK, request permissions, listen for meeting detection and recording end events, and start a recording.

```APIDOC
## SDK Initialization and Usage

### Description
This example shows how to initialize the Recall.ai Desktop SDK, request necessary permissions, listen for meeting detection and recording end events, and start a recording.

### Code Example
```javascript
import RecallAiSdk from '@recallai/desktop-sdk';

RecallAiSdk.init({
  api_url: "https://us-west-2.recall.ai"
});

RecallAiSdk.requestPermission("accessibility");
RecallAiSdk.requestPermission("microphone");
RecallAiSdk.requestPermission("screen-capture");

RecallAiSdk.addEventListener('meeting-detected', async (evt) => {
  const res = await Backend.fetch(`/api/create_sdk_recording`, AppState.client_token);
  const payload = await res.json();
  
  await RecallAiSdk.startRecording({
    windowId: evt.window.id,
    uploadToken: res.upload_token
  });
});

RecallAiSdk.addEventListener('recording-ended', async (evt) => {
  console.log(`Uploaded evt.window.id `);
});
```

### Methods
- **init(options)** - Initializes the SDK with the given options.
- **requestPermission(permission)** - Requests a specific permission (e.g., "accessibility", "microphone", "screen-capture").
- **addEventListener(event, callback)** - Registers a callback for an SDK event.
- **startRecording(options)** - Starts a recording with the given options.

### Events
- **meeting-detected** - Fired when a meeting is detected.
- **recording-ended** - Fired when a recording ends.

### Parameters
#### init options
- **api_url** (string) - Required - The API URL for the Recall.ai platform.

#### startRecording options
- **windowId** (string) - Required - The ID of the window to record.
- **uploadToken** (string) - Required - The upload token for the recording.

```

--------------------------------

### Start ngrok tunnel with example static domain and port

Source: https://docs.recall.ai/docs/local-webhook-development

Example command using the static domain my-static-domain.ngrok-free.app and port 8080. This forwards events sent to the public domain to localhost:8080.

```bash
ngrok http --domain my-static-domain.ngrok-free.app 8080
```

--------------------------------

### Meeting detected to recording started flow

Source: https://docs.recall.ai/docs/desktop-sdk

Initialize the SDK and use the meeting-detected event to start recording. This example shows the initial setup.

```javascript
import RecallAiSdk from '@recallai/desktop-sdk';

RecallAiSdk.init({
  api_url: "https://us-west-2.recall.ai"
});
```

--------------------------------

### Prepare desktop audio recording with prepareDesktopAudioRecording()

Source: https://docs.recall.ai/docs/desktop-recording-sdk-methods

Prepares whole-desktop audio recording parts. In addition to video-platform meetings, this feature allows real-time note-takers for in-person meetings or unsupported platforms. The example fetches an upload token from the backend and starts recording with it.

```JavaScript
import RecallAiSdk from '@recallai/desktop-sdk';

const res = await Backend.fetch(`/api/create_sdk_recording`, AppState.client_token);
const payload = await res.json();
const windowId = await RecallAiSdk.prepareDesktopAudioRecording();

await RecallAiSdk.startRecording({
  windowId,
  uploadToken: res.upload_token
});
```

--------------------------------

### Minimal Desktop SDK example

Source: https://docs.recall.ai/docs/desktop-sdk

Initializes the Recall.ai Desktop SDK, requests permissions, and starts recording when a meeting is detected. The recording-ended event logs the window ID.

```javascript
import RecallAiSdk from '@recallai/desktop-sdk';

RecallAiSdk.init({
  api_url: "https://us-west-2.recall.ai"
});

RecallAiSdk.requestPermission("accessibility");
RecallAiSdk.requestPermission("microphone");
RecallAiSdk.requestPermission("screen-capture");

RecallAiSdk.addEventListener('meeting-detected', async (evt) => {
  const res = await Backend.fetch(`/api/create_sdk_recording`, AppState.client_token);
  const payload = await res.json();
	
  await RecallAiSdk.startRecording({
    windowId: evt.window.id,
    uploadToken: res.upload_token
  });
});

RecallAiSdk.addEventListener('recording-ended', async (evt) => {
  console.log(`Uploaded evt.window.id `);
});
```

--------------------------------

### 200 Response Example

Source: https://docs.recall.ai/reference/bot_output_media_create

Example JSON response from the output media creation endpoint, showing bot configuration fields.

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "meeting_url": {
    "platform": "webex",
    "meeting_subdomain": "string",
    "meeting_personal_room_id": "string",
    "meeting_mtid": "string",
    "meeting_path": "string"
  },
  "bot_name": "Meeting Notetaker",
  "join_at": "2026-10-13T16:08:24.899Z",
  "recording_config": {
    "transcript": {
      "metadata": {
        "additionalProp": "string"
      },
      "provider": {
        "recallai_streaming": {
          "language_code": "auto",
          "spelling": [
            {
              "find": [
                "string"
              ],
              "replace": "string"
            }
          ],
          "key_terms": [
            "string"
          ],
          "filter_profanity": false,
          "mode": "prioritize_accuracy"
        },
        "assembly_ai_async_chunked": {
          "speech_model": null,
          "language_code": "en_us",
          "language_detection": true,
          "language_confidence_threshold": 0.7,
          "punctuate": true,
          "format_text": true,
          "multichannel": true,
          "webhook_url": "https://your-webhook-url.tld/path",

```

--------------------------------

### Install Desktop SDK via npm (Stable and Nightly channels)

Source: https://docs.recall.ai/docs/desktop-sdk

Install the @recallai/desktop-sdk package. The nightly channel is bleeding edge but potentially less stable.

```shell
# Stable channel
npm install @recallai/desktop-sdk

# Nightly channel (bleeding edge, but potentially less stable)
npm install @recallai/desktop-sdk@nightly
```

--------------------------------

### Start recording with Raw Media (startRecording)

Source: https://docs.recall.ai/docs/desktop-recording-sdk-raw-media

Use `startRecording` to start a recording. Raw Media is selected automatically when enabled for the workspace and available for the detected meeting.

```JavaScript
RecallAiSdk.addEventListener("meeting-detected", async (evt) => {
  const upload = await createDesktopSdkUploadOnYourBackend();

  await RecallAiSdk.startRecording({
    windowId: evt.window.id,
    uploadToken: upload.upload_token,
  });
});
```

--------------------------------

### Example: NSMicrophoneUsageDescription

Source: https://docs.recall.ai/docs/macos-permissions

Example usage description string for microphone access, explaining the need to record voice during calls.

```XML
<key>NSMicrophoneUsageDescription</key>
<string>This app uses the microphone to record your voice during calls.</string>
```

--------------------------------

### Start recording with Raw Media

Source: https://docs.recall.ai/docs/desktop-recording-sdk-raw-media

Starts a recording using the Desktop SDK. Raw Media is selected automatically when enabled and available.

```APIDOC
## startRecording

### Description
Starts a recording using the Desktop SDK. Raw Media is selected automatically when it is enabled for the workspace and available for the detected meeting.

### Method
SDK Method

### Endpoint
`RecallAiSdk.startRecording(options)`

### Parameters
#### Request Body
- **windowId** (string) - Required - The ID of the window to record.
- **uploadToken** (string) - Required - The upload token obtained from your backend.
- **disableRawMedia** (boolean) - Optional - Set to `true` to disable Raw Media and use local capture. Defaults to `false`.

### Request Example
```javascript
await RecallAiSdk.startRecording({
  windowId: evt.window.id,
  uploadToken: upload.upload_token,
});
```

### Response
No response body is documented. The recording starts asynchronously.

```

--------------------------------

### Example: NSAudioCaptureUsageDescription

Source: https://docs.recall.ai/docs/macos-permissions

Example usage description string for system audio capture, explaining the need to record meetings and playback sessions.

```XML
<key>NSAudioCaptureUsageDescription</key>
<string>This app captures system audio to record meetings and playback sessions.</string>
```

--------------------------------

### Start a Node.js server and ngrok tunnel

Source: https://docs.recall.ai/docs/testing-webhooks-locally

Starts a Node.js server on port 3000 and exposes it publicly at my-static-domain.ngrok-free.app using ngrok. Run the server command first, then in a new terminal start the tunnel.

```shell
# Start the server
npm run start --port 3000

# In a new terminal: Start the ngrok tunnel
ngrok http --domain my-static-domain.ngrok-free.app 3000
```

--------------------------------

### Add trustedDependencies for Bun installation

Source: https://docs.recall.ai/docs/desktop-sdk

When using Bun, add @recallai/desktop-sdk to the trustedDependencies list in package.json for proper installation.

```json
{
  ...,
  "trustedDependencies": ["@recallai/desktop-sdk"]
}
```

--------------------------------

### Example 200 response for update audio separate

Source: https://docs.recall.ai/reference/audio_separate_partial_update

Example response body for a successful PATCH request. Shows the artifact ID, recording details, status, metadata, data with download URL, and format.

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recording": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "metadata": {
      "additionalProp": "string"
    }
  },
  "created_at": "2026-10-13T16:07:23.625Z",
  "status": {
    "code": "processing",
    "sub_code": "string",
    "updated_at": "2026-10-13T16:07:23.625Z"
  },
  "metadata": {
    "additionalProp": "string"
  },
  "data": {
    "download_url": "string"
  },
  "format": "raw"
}
```

--------------------------------

### Example Response for Update Recording Preferences

Source: https://docs.recall.ai/reference/calendar_user_update

Example response body for a successful update request. It includes the calendar user's ID, external ID, connections, and preferences object with recording settings.

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "string",
  "connections": [
    {
      "connected": true,
      "platform": "string",
      "email": "string",
      "id": "string"
    }
  ],
  "preferences": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "record_non_host": true,
    "record_recurring": true,
    "record_external": true,
    "record_internal": true,
    "record_confirmed": true,
    "record_only_host": true,
    "bot_name": "string"
  }
}
```

--------------------------------

### POST /recordings/start

Source: https://docs.recall.ai/docs/bot-real-time-transcription

Documentation for the Start Recording endpoint, used to start a new recording with a different real-time transcription provider when the initial transcription fails.

```APIDOC
## [POST] /recordings/start

### Description
Starts a new recording with a specified recording configuration. This endpoint is used to switch to a fallback real-time transcription provider when the initial transcription fails.

### Method
POST

### Endpoint
/recordings/start

### Parameters
#### Request Body
- **recording_config** (object) - Required - The full recording configuration for the new recording. Must include all required and desired settings, including the real-time transcription provider.

### Request Example
{
  "recording_config": {
    "realtime_endpoints": [
      {
        "url": "wss://example.com/transcription",
        "type": "transcription"
      }
    ]
  }
}

### Response
#### Success Response (200)
- **recording** (object) - The newly created recording artifact.

#### Response Example
{
  "recording": {
    "id": "rec_123",
    "metadata": {}
  }
}

```

--------------------------------

### Initialize SDK with init({apiUrl})

Source: https://docs.recall.ai/docs/desktop-recording-sdk-methods

Initializes the Desktop Recording SDK. Pass the apiUrl parameter matching your Recall.ai workspace region; for US (Pay-as-you-go) use https://us-west-2.recall.ai, US (Monthly plan) https://us-east-1.recall.ai, EU https://eu-central-1.recall.ai, and Japan https://ap-northeast-1.recall.ai.

```JavaScript
RecallAiSdk.init({
  apiUrl: "https://us-west-2.recall.ai",
});
```

--------------------------------

### Example Response for Get Access Token

Source: https://docs.recall.ai/reference/zoom_oauth_credentials_access_token_retrieve

Example JSON response showing the access token and its expiration date.

```json
{
  "token": "string",
  "expires_at": "2026-10-13T16:17:19.848Z"
}
```

--------------------------------

### Create a bot with audio_separate_raw

Source: https://docs.recall.ai/docs/how-to-get-separate-audio-per-participant-async

Create a bot with `recording_config.audio_separate_raw = {}` to get separate audio per participant. The cURL example shows the required request body; the TypeScript and Python examples use `video_separate_mp4` instead, which is a different setting. Update the placeholders `YOUR_RECALL_API_KEY` and `YOUR_MEETING_URL` before use.

```cURL
curl --request POST \
     --url https://us-west-2.recall.ai/api/v1/bot \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'authorization: YOUR_RECALL_API_KEY' \
     --data '
{
  "meeting_url": "YOUR_MEETING_URL",
  "recording_config": {
    "audio_separate_raw": {} # Add this to your request body
  }
}
'

```

```TypeScript
const response = await fetch("https://us-west-2.recall.ai/api/v1/bot", {
  method: "POST",
  headers: {
    "accept": "application/json",
    "content-type": "application/json"
    "authorization": "YOUR_RECALL_API_KEY" // Update this
  },
  body: JSON.stringify({
    meeting_url: "YOUR_MEETING_URL", // Update this
    recording_config: {
      video_separate_mp4: {} # Add this to your request body
    }
  })
});

if (!response.ok) {
  throw new Error(`Error: ${response.status} ${response.statusText}`);
}

const data = await response.json();

```

```Python
import requests

response = requests.post(
    "https://us-west-2.recall.ai/api/v1/bot",
    json={
      "meeting_url": "YOUR_MEETING_URL", # Update this
      "recording_config": {
		    "video_separate_mp4": {} # Add this to your request body
      }
    },
    headers={
      "accept": "application/json",
      "content-type": "application/json",
    	"authorization": "YOUR_RECALL_API_KEY" # Update this
    }
)

if not response.ok:
 	errorMessage = f"Error: {response.status_code} - {response.text}"
  raise requests.RequestException(errorMessage)
  
result = response.json()

```

--------------------------------

### Google Calendar raw event payload example

Source: https://docs.recall.ai/docs/calendar-event-platform-data

Example JSON payload for a Google Calendar event, showing fields like id, start, end, attendees, conferenceData, and reminders. Use this to understand the structure of the 'raw' field for Google Calendar events in calendar v2.

```json
{
  "id": "5qd60oqa8t0dgqlon2msci0a37_20240501T213000Z",
  "end": {
    "dateTime": "2024-05-01T18:00:00-04:00",
    "timeZone": "America/New_York"
  },
  "etag": "3427970920200000",
  "kind": "calendar#event",
  "start": {
    "dateTime": "2024-05-01T17:30:00-04:00",
    "timeZone": "America/New_York"
  },
  "status": "confirmed",
  "created": "2024-02-15T12:10:25.000Z",
  "creator": {
    "email": "dummy@example.com"
  },

  "iCalUID": "5dgqlon2msci0a37qd60oqa8t0_R20240513T213000@google.com",
  "summary": "Meeting Summary",
  "updated": "2024-04-30T18:20:15.000Z",
  "htmlLink": "https://dummy.calendar.com/event?eid=5qd60oqa8t0dgqlon2msci0a37_20240501T213000Z",
  "sequence": 0,
  "attendees": [
    {
      "email": "dummy@example.com",
      "organizer": true,
      "responseStatus": "accepted"
    },
    {
      "email": "dummy1@example.com",
      "responseStatus": "accepted"
    },
    {
      "email": "dummy2@example.com",
      "responseStatus": "accepted"
    },
    {
      "email": "dummy3@example.com",
      "responseStatus": "accepted"
    },
    {
      "self": true,
      "email": "dummy4@example.com",
      "responseStatus": "accepted"
    }
  ],
  "eventType": "default",
  "organizer": {
    "email": "dummy@example.com"
  },
  "reminders": {
    "useDefault": true
  },
  "hangoutLink": "https://meet.google.com/dummy-meet-link",
  "conferenceData": {
    "entryPoints": [
      {
        "uri": "https://meet.google.com/dummy-meet-link",
        "label": "meet.google.com/dummy-meet-link",
        "entryPointType": "video"
      },
      {
        "pin": "123456",
        "uri": "https://tel.meet/dummy-meet-link?pin=123456",
        "entryPointType": "more"
      },
      {
        "pin": "789101",
        "uri": "tel:+1-234-567-8901",
        "label": "+1 234-567-8901",
        "regionCode": "US",
        "entryPointType": "phone"
      }
    ],
    "conferenceId": "dummy-conference-id",
    "conferenceSolution": {
      "key": {
        "type": "dummy_type"
      },
      "name": "Dummy Meet",
      "iconUri": "https://dummy.com/dummy-meet-icon.png"
    }
  },
  "recurringEventId": "dummy_recurring_event_id",
  "originalStartTime": {
    "dateTime": "2024-05-01T17:30:00-04:00",
    "timeZone": "America/New_York"
  }
}
```

--------------------------------

### prepareDesktopAudioRecording()

Source: https://docs.recall.ai/docs/desktop-recording-sdk-methods

Prepares the SDK for whole-desktop audio recording, returning a windowId to be used with startRecording.

```APIDOC
## prepareDesktopAudioRecording()

### Description
In addition to recording video-platform meetings, the Desktop Recording SDK can also record whole-desktop audio. This can be used to implement, for example, realtime note-takers for in person meetings or for platforms not yet supported by the Desktop Recording SDK.

### Method
prepareDesktopAudioRecording

### Parameters
No parameters are documented.

### Request Example
```javascript
import RecallAiSdk from '@recallai/desktop-sdk';

const res = await Backend.fetch(`/api/create_sdk_recording`, AppState.client_token);
const payload = await res.json();
const windowId = await RecallAiSdk.prepareDesktopAudioRecording();

await RecallAiSdk.startRecording({
  windowId,
  uploadToken: res.upload_token
});
```

### Response
Returns a `windowId` (type not specified) that can be used with `startRecording`.
```

--------------------------------

### ngrok tunnel startup output

Source: https://docs.recall.ai/docs/local-webhook-development

Example terminal output shown after starting the ngrok tunnel. It displays session status, account, version, region, and forwarding URL.

```text

Session Status                online
Account                       johndoe (Plan: Free)
Version                       3.5.0
Region                        United States (us)
Latency                       -
Web Interface                 http://127.0.0.1:4040
Forwarding                    https://my-static-domain.ngrok-free.app -> http://localhost:8080

Connections                   ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00


```

--------------------------------

### Initialize Desktop SDK with apiUrl

Source: https://docs.recall.ai/docs/desktop-sdk

Initialize the SDK once at startup. The apiUrl must match the region of your Recall.ai workspace.

```javascript
const RecallAiSdk = require('@recallai/desktop-sdk');

RecallAiSdk.init({
  apiUrl: "https://us-west-2.recall.ai"
});
```

--------------------------------

### [POST] /api/create_sdk_recording

Source: https://docs.recall.ai/docs/desktop-sdk

Creates a Desktop SDK upload and returns an upload token for starting a recording.

```APIDOC
## [POST] /api/create_sdk_recording

### Description
Creates a Desktop SDK upload and returns an upload token for starting a recording.

### Method
POST

### Endpoint
/api/create_sdk_recording

### Request Body
- **recording_config** (object) - Required - Configuration for the recording, including transcript provider and realtime endpoints.
  - **transcript** (object) - Optional - Configuration for transcription.
    - **provider** (object) - Optional - The transcription provider configuration.
      - **assembly_ai_v3_streaming** (object) - Optional - Parameters for AssemblyAI's real-time models.
  - **realtime_endpoints** (array) - Optional - List of realtime endpoint configurations.
    - **type** (string) - Required - The type of realtime endpoint, e.g., `desktop_sdk_callback`.
    - **events** (array of strings) - Required - List of event types to subscribe to.

### Request Example
```json
{
  "recording_config": {
    "transcript": {
      "provider": {
        "assembly_ai_v3_streaming": {}
      }
    },
    "realtime_endpoints": [
      {
        "type": "desktop_sdk_callback",
        "events": ["participant_events.join", "transcript.data"]
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **upload_token** (string) - Token to be used with `startRecording()`.

#### Response Example
```json
{
  "upload_token": "your_upload_token"
}
```
```

--------------------------------

### Webhook events received by the server

Source: https://docs.recall.ai/docs/testing-webhooks-locally

Example output showing webhook events received by the server after the bot joins the call and starts recording. Events include bot.joining_call, bot.in_waiting_room, bot.in_call_not_recording, and bot.in_call_recording.

```plaintext
received event: {"data":{"data":{"code":"joining_call","updated_at":"2024-02-17T16:44:00.505440+00:00","sub_code":null}}, "bot": {"id": "92e24581-f82b-401a-8f75-88e64b04c24e", "metadata": {}}},"event":"bot.joining_call"}
received event: {"data":{"data":{"code":"in_waiting_room","updated_at":"2024-02-17T16:44:23.288984+00:00","sub_code":null}}, "bot": {"id": "92e24581-f82b-401a-8f75-88e64b04c24e", "metadata": {}}},"event":"bot.in_waiting_room"}
received event: {"data":{"data":{"code":"in_call_not_recording","updated_at":"2024-02-17T16:44:23.288984+00:00","sub_code":null}}, "bot": {"id": "92e24581-f82b-401a-8f75-88e64b04c24e", "metadata": {}}},"event":"bot.in_call_not_recording"}
received event: {"data":{"data":{"code":"in_call_recording","updated_at":"2024-02-17T16:44:23.288984+00:00","sub_code":null}}, "bot": {"id": "92e24581-f82b-401a-8f75-88e64b04c24e", "metadata": {}}},"event":"bot.in_call_recording"}
```

--------------------------------

### cURL Request to Get Calendar Auth Token

Source: https://docs.recall.ai/reference/calendar_authenticate_create

Sends a POST request to the calendar authenticate endpoint. The request body is empty in the example, but the user_id parameter is required. The response contains a token valid for 1 day.

```shell
curl --request POST \
     --url https://us-east-1.recall.ai/api/v1/calendar/authenticate/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

--------------------------------

### RecallAiSdk.startRecording({ windowId, uploadToken })

Source: https://docs.recall.ai/docs/desktop-sdk

Starts recording the specified window or audio source using the provided upload token.

```APIDOC
## RecallAiSdk.startRecording({ windowId, uploadToken })

### Description
Starts recording the specified window or audio source using the provided upload token.

### Method
startRecording

### Parameters
- **windowId** (string) - Required - The ID of the window or audio source to record.
- **uploadToken** (string) - Required - The upload token obtained from the Create Desktop SDK Upload endpoint.

### Example
```javascript
await RecallAiSdk.startRecording({
  windowId: evt.window.id,
  uploadToken: res.upload_token
});
```
```

--------------------------------

### Create Bot with automatic_audio_output configuration

Source: https://docs.recall.ai/docs/output-audio-in-meetings

Example of a Create Bot request that automatically outputs an MP3 audio clip when recording starts, with optional replay when participants join. The `data` object specifies the MP3 as a base64 string, and `replay_on_participant_join` configures debounce behavior and a disable-after time.

```json
// POST https://us-east-1.recall.ai/api/v1/bot/
{
  "automatic_audio_output": {
    "in_call_recording": {
      "data": {
        "kind": "mp3",
        "b64_data": "..."
      },
      "replay_on_participant_join": {
        "debounce_mode": "trailing",
        "debounce_interval": 10,
        "disable_after": 60
      }
    }
  },
  ...
}
```

--------------------------------

### Configure third-party transcription provider in Recall dashboard

Source: https://docs.recall.ai/docs/agent-quickstarts

Before using a third-party transcription provider, the agent must instruct the human to configure that provider's credentials in the Recall dashboard for the same RECALL_REGION used for the API. The human must open the Third-Party Transcription setup guide and the dashboard matching their RECALL_REGION (us-east-1, us-west-2, eu-central-1, or ap-northeast-1), then select the provider and enter its credentials.

```text
1. Open the third-party transcription setup guide: [Third-Party Transcription](https://docs.recall.ai/docs/ai-transcription).
2. Open the Recall dashboard that matches your `RECALL_REGION`:
   - `us-east-1`: [US East dashboard](https://us-east-1.recall.ai/dashboard/transcription)
   - `us-west-2`: [US West dashboard](https://us-west-2.recall.ai/dashboard/transcription)
   - `eu-central-1`: [EU dashboard](https://eu-central-1.recall.ai/dashboard/transcription)
   - `ap-northeast-1`: [Japan dashboard](https://ap-northeast-1.recall.ai/dashboard/transcription)
3. Select the transcription provider you want to use.
4. Enter that provider's credentials in the Recall dashboard.
```

--------------------------------

### GET /api/v2/zoom-oauth-apps/{id}/

Source: https://docs.recall.ai/reference/zoom_oauth_apps_retrieve

Get a Zoom OAuth App by ID.

```APIDOC
## [GET] https://us-east-1.recall.ai/api/v2/zoom-oauth-apps/{id}/n
### Description
Get a Zoom OAuth App.

### Method
GET

### Endpoint
https://us-east-1.recall.ai/api/v2/zoom-oauth-apps/{id}/

### Parameters
#### Path Parameters
- **id** (uuid) - Required - A UUID string identifying this zoom o auth app.

### Request Example
No request body needed. The request uses GET method.

### Response
#### Success Response (200)
Response body is an object with the following fields:
- **id** (uuid) - Required
- **kind** (string) - Required - enum: `user_level` (User Level), `account_level` (Account Level)
- **client_id** (string) - Required - length ≤ 200
- **client_secret** (string) - Required - length ≤ 200
- **webhook_secret** (string) - Required - length ≤ 200
- **webhook_last_validation** (date-time | null) - Required
- **created_at** (date-time) - Required

#### Response Example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "kind": "user_level",
  "client_id": "string",
  "client_secret": "string",
  "webhook_secret": "string",
  "webhook_last_validation": "2026-10-13T16:16:29.721Z",
  "created_at": "2026-10-13T16:16:29.721Z"
}

### cURL Request Example
```
curl --request GET \
     --url https://us-east-1.recall.ai/api/v2/zoom-oauth-apps/id/ \
     --header 'accept: application/json'
```
```

--------------------------------

### Create bot with video config (Python)

Source: https://docs.recall.ai/docs/how-to-get-separate-audio-per-participant-realtime

Python example for creating a bot. Similar to the TypeScript snippet, it uses `video_mixed_layout` and `video_separate_mp4` instead of `audio_separate_raw`. Update the `authorization` header with your API key.

```python
import requests

response = requests.post(
    "https://us-west-2.recall.ai/api/v1/bot",
    json={
      "meeting_url": "YOUR_MEETING_URL", # Update this
      "recording_config": {
	      "video_mixed_layout": "gallery_view_v2", # Add this to your request body
		    "video_separate_mp4": {} # Add this to your request body
      }
    },
    headers={
      "accept": "application/json",
      "content-type": "application/json",
    	"authorization": "YOUR_RECALL_API_KEY" # Update this
    }
)

if not response.ok:
 	errorMessage = f"Error: {response.status_code} - {response.text}"
  raise requests.RequestException(errorMessage)
  
result = response.json()
```

--------------------------------

### Start Recording Endpoint

Source: https://docs.recall.ai/reference/real-time-transcription

The Start Recording endpoint is used to start a new recording with a different real-time transcription provider as a fallback when real-time transcription fails. It creates a new recording artifact and replaces the recording_config in full.

```APIDOC
## Start Recording Endpoint

### Description
Call this endpoint to start a new recording with a different real-time transcription provider as a fallback when real-time transcription fails. This creates a new recording artifact and replaces the recording_config in full.

### Important Notes
- Calling this endpoint creates a new recording artifact. A bot can have multiple recording artifacts associated with it, and the Retrieve Bot response may include multiple entries in the `recordings` array.
- The `recording_config` for the new recording does not inherit missing fields from the previous recording. The configuration is replaced in full, so the request must include all required and desired settings, not only the transcription provider.
- The `recording_config` returned on the original bot artifact (e.g. response from the Retrieve Bot request) and in the dashboard reflects the initial Create Bot request, not the updated recording configuration used when the new recording was started.

### Usage
Listen for the `transcript.failed` webhook event and call this endpoint with a new `recording_config` that uses a different real-time transcription provider.
```

--------------------------------

### Create bot with video_separate_mp4 and web_4_core variant (cURL, TypeScript, Python)

Source: https://docs.recall.ai/docs/how-to-get-separate-videos-per-participant-async

Create a bot that records separate MP4 videos per participant. Set `recording_config.video_mixed_layout` to `"gallery_view_v2"` and `video_separate_mp4` to `{}`. Configure the `variant` to `web_4_core` for CPU-intensive processing; those machines cost an additional $0.10/hr over standard bot usage. Replace placeholders like `YOUR_RECALL_API_KEY` and `YOUR_MEETING_URL` before running.

```cURL
curl --request POST \
     --url https://us-west-2.recall.ai/api/v1/bot \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'authorization: YOUR_RECALL_API_KEY' \
     --data '
{
  "meeting_url": "{MEETING_URL}",
  "recording_config": {
    "video_mixed_layout": "gallery_view_v2",
    "video_separate_mp4": {}
  },
  "variant": {
    "zoom": "web_4_core",
    "google_meet": "web_4_core",
    "microsoft_teams": "web_4_core"
  }
}
'
```

```TypeScript
const response = await fetch("https://us-west-2.recall.ai/api/v1/bot", {
  method: "POST",
  headers: {
    "accept": "application/json",
    "content-type": "application/json"
    "authorization": "YOUR_RECALL_API_KEY" // Update this
  },
  body: JSON.stringify({
    meeting_url: "YOUR_MEETING_URL", // Update this
    recording_config: {
      video_mixed_layout: "gallery_view_v2", // Add this to your request body
      video_separate_mp4: {} # Add this to your request body
    }
  })
});

if (!response.ok) {
  throw new Error(`Error: ${response.status} ${response.statusText}`);
}

const data = await response.json();
```

```Python
import requests

response = requests.post(
    "https://us-west-2.recall.ai/api/v1/bot",
    json={
      "meeting_url": "YOUR_MEETING_URL", # Update this
      "recording_config": {
	      "video_mixed_layout": "gallery_view_v2" # Add this to your request body
		    "video_separate_mp4": {} # Add this to your request body
      }
    },
    headers={
      "accept": "application/json",
      "content-type": "application/json",
    	"authorization": "YOUR_RECALL_API_KEY" # Update this
    }
)

if not response.ok:
 	errorMessage = f"Error: {response.status_code} - {response.text}"
  raise requests.RequestException(errorMessage)
  
result = response.json()
```

--------------------------------

### Create bot with audio_mixed_mp3 config (TypeScript)

Source: https://docs.recall.ai/docs/how-to-get-mixed-audio-async

Use this TypeScript fetch example to create a bot with mixed MP3 audio enabled. Set `recording_config.audio_mixed_mp3` to an empty object in the request body. Replace `YOUR_RECALL_API_KEY` and `YOUR_MEETING_URL` with your credentials and meeting URL.

```typescript
const response = await fetch("https://us-west-2.recall.ai/api/v1/bot", {
  method: "POST",
  headers: {
    "accept": "application/json",
    "content-type": "application/json"
    "authorization": "YOUR_RECALL_API_KEY" // Update this
  },
  body: JSON.stringify({
    meeting_url: "YOUR_MEETING_URL", // Update this
    recording_config: {
      audio_mixed_mp3: {} # Add this to your request body
    }
  })
});

if (!response.ok) {
  throw new Error(`Error: ${response.status} ${response.statusText}`);
}

const data = await response.json();
```

--------------------------------

### init({apiUrl})

Source: https://docs.recall.ai/docs/desktop-recording-sdk-methods

Initializes the SDK with the required apiUrl parameter corresponding to the region of your Recall.ai workspace.

```APIDOC
## init({apiUrl})

### Description
Initializes the SDK. You'll need to pass this parameter on startup.

### Method
init

### Parameters
#### Request Body
- **apiUrl** (string) - Required - The URL corresponding to the region your Recall.ai workspace belongs to. Valid values: https://us-west-2.recall.ai (US Pay-as-you-go), https://us-east-1.recall.ai (US Monthly plan), https://eu-central-1.recall.ai (EU), https://ap-northeast-1.recall.ai (Japan).

### Request Example
```javascript
RecallAiSdk.init({
  apiUrl: "https://us-west-2.recall.ai",
});
```

### Response
No response is documented.
```

--------------------------------

### Start Screenshare

Source: https://docs.recall.ai/llms.txt

Causes the bot to start screensharing. Rate limit: 300 requests per min per workspace.

```APIDOC
## [POST] /bots/{id}/output_screenshare

### Description
Causes the bot to start screensharing.

### Method
POST

### Endpoint
/bots/{id}/output_screenshare

### Rate Limit
300 requests per min per workspace
```

--------------------------------

### Create Desktop SDK Upload - Minimal Request

Source: https://docs.recall.ai/docs/desktop-sdk

POST to the Create Desktop SDK Upload endpoint with your API key. By default, records video and captures participant events.

```javascript
const url = 'https://us-west-2.recall.ai/api/v1/sdk_upload/';
const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    Authorization: 'YOUR_API_KEY'
  }
};

fetch(url, options)
```

--------------------------------

### 200 Response Example

Source: https://docs.recall.ai/reference/bot_send_chat_message_create

Example response body for a successful request, showing the bot object with meeting details and recording configuration.

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "meeting_url": {
    "platform": "webex",
    "meeting_subdomain": "string",
    "meeting_personal_room_id": "string",
    "meeting_mtid": "string",
    "meeting_path": "string"
  },
  "bot_name": "Meeting Notetaker",
  "join_at": "2026-10-13T16:09:14.635Z",
  "recording_config": {
    "transcript": {
      "metadata": {
        "additionalProp": "string"
      },
      "provider": {
        "recallai_streaming": {
          "language_code": "auto",
          "spelling": [
            {
              "find": [
                "string"
              ],
              "replace": "string"
            }
          ],
          "key_terms": [
            "string"
          ],
          "filter_profanity": false,
          "mode": "prioritize_accuracy"
        },
        "assembly_ai_async_chunked": {
          "speech_model": null,
          "language_code": "en_us",
          "language_detection": true,
          "language_confidence_threshold": 0.7,
          "punctuate": true,
          "format_text": true,
          "multichannel": true,
        }
      }
    }
  }
}
```

--------------------------------

### Start Screenshare (Stop)

Source: https://docs.recall.ai/llms.txt

Causes the bot to start screensharing. Rate limit: 300 requests per min per workspace.

```APIDOC
## [DELETE] /bots/{id}/output_screenshare

### Description
Causes the bot to start screensharing.

### Method
DELETE

### Endpoint
/bots/{id}/output_screenshare

### Rate Limit
300 requests per min per workspace
```

--------------------------------

### Create Desktop SDK Upload with transcription enabled (cURL)

Source: https://docs.recall.ai/docs/transcription-overview

POST to /api/v1/sdk_upload/ with the same transcription configuration as the bot example. Requires RECALLAI_API_KEY.

```cURL
curl --request POST \
     --url https://RECALL_REGION.recall.ai/api/v1/sdk_upload/ \
     --header "Authorization: RECALLAI_API_KEY" \
     --header "accept: application/json" \
     --header "content-type: application/json" \
     --data '
{
  "recording_config": {
    "transcript": {
      "provider": {
        "recallai_streaming": {
          "mode": "prioritize_accuracy", 
          "language_code": "auto"
        }
      },
      "diarization": {
        "use_separate_streams_when_available": true
      }
    }
  }
}
'
```

--------------------------------

### Create bot with audio_mixed_mp3 config (Python)

Source: https://docs.recall.ai/docs/how-to-get-mixed-audio-async

Use this Python requests example to create a bot with mixed MP3 audio enabled. Set `recording_config.audio_mixed_mp3` to an empty object in the request body. Replace `YOUR_RECALL_API_KEY` and `YOUR_MEETING_URL` with your credentials and meeting URL.

```python
import requests

response = requests.post(
    "https://us-west-2.recall.ai/api/v1/bot",
    json={
      "meeting_url": "YOUR_MEETING_URL", # Update this
      "recording_config": {
		    "audio_mixed_mp3": {} # Add this to your request body
      }
    },
    headers={
      "accept": "application/json",
      "content-type": "application/json",
    	"authorization": "YOUR_RECALL_API_KEY" # Update this
    }
)

if not response.ok:
 	errorMessage = f"Error: {response.status_code} - {response.text}"
  raise requests.RequestException(errorMessage)
  
result = response.json()
```

--------------------------------

### Create bot with video config (TypeScript)

Source: https://docs.recall.ai/docs/how-to-get-separate-audio-per-participant-realtime

TypeScript example for creating a bot. Note: this snippet uses `video_mixed_layout` and `video_separate_mp4` instead of `audio_separate_raw`; it appears to be an alternative configuration. The `authorization` header must be updated with your API key.

```typescript
const response = await fetch("https://us-west-2.recall.ai/api/v1/bot", {
  method: "POST",
  headers: {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "YOUR_RECALL_API_KEY" // Update this
  },
  body: JSON.stringify({
    meeting_url: "YOUR_MEETING_URL", // Update this
    recording_config: {
      video_mixed_layout: "gallery_view_v2", // Add this to your request body
      video_separate_mp4: {} // Add this to your request body
    }
  })
});

if (!response.ok) {
  throw new Error(`Error: ${response.status} ${response.statusText}`);
}

const data = await response.json();
```

--------------------------------

### Error: update_bot_failed when bot has started joining

Source: https://docs.recall.ai/docs/creating-and-scheduling-bots

Returned when attempting to update a bot after it has started joining or is in the call. The bot cannot be updated at this stage.

```json
{
"code": "update_bot_failed",
"detail": "Only non-dispatched bots can be updated"
}
```

--------------------------------

### Initialize SDK and request permissions manually

Source: https://docs.recall.ai/docs/macos-permissions

Initializes the Desktop SDK with acquirePermissionsOnStartup set to an empty array to prevent automatic permission requests, then manually requests accessibility, microphone, and screen-capture permissions. Use this when you want to control when permission dialogs appear and provide custom UI for the permission flow.

```javascript
const RecallAiSdk = require('@recallai/desktop-sdk');

await RecallAiSdk.init({
  apiUrl: "https://us-west-2.recall.ai",
  acquirePermissionsOnStartup: []
});

await RecallAiSdk.requestPermission("accessibility")
await RecallAiSdk.requestPermission("microphone")
await RecallAiSdk.requestPermission("screen-capture")
```

--------------------------------

### Create desktop recording with Recall.ai real-time transcription (JavaScript)

Source: https://docs.recall.ai/docs/desktop-recording-sdk-real-time-transcription

Use this POST request to create a desktop recording that transcribes in real time with Recall.ai. Replace YOUR_RECALL_REGION with your Recall region (us-west-2, us-east-1, eu-central-1, or ap-northeast-1) and YOUR_API_KEY with an API key. Note that recallai_streaming only supports mode: prioritize_low_latency.

```JavaScript
const url = 'https:/YOUR_RECALL_REGION.recall.ai/api/v1/sdk_upload/';

const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    Authorization: 'YOUR_API_KEY'
  },
  body: JSON.stringify({
    recording_config: {
      transcript: {
        provider: {
          recallai_streaming: {}
        }
      },
      realtime_endpoints: [
        {
          type: 'desktop_sdk_callback',
          events: ['transcript.data', 'transcript.partial_data']
        }
      ]
    }
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

--------------------------------

### Create Desktop SDK Upload

Source: https://docs.recall.ai/llms.txt

Create a new Desktop SDK upload. Rate limit: 300 requests per min per workspace.

```APIDOC
## Create Desktop SDK Upload

### Description
Create a new Desktop SDK upload.

### Rate Limit
300 requests per min per workspace
```

--------------------------------

### Get Access Token

Source: https://docs.recall.ai/llms.txt

Get the OAuth access token for this calendar account. The base rate limit is 300 requests per minute per workspace.

```APIDOC
## Get Access Token

### Description
Get the OAuth access token for this calendar account.

### Endpoint
`/calendars/{id}/access_token`

### Method
POST

### Rate Limit
300 requests per min per workspace

```
Tokens:
Raw