Bot API Overview

​

Core Capabilities

• Bot Lifecycle Management: Create, retrieve, update, list, and delete bots
• Recording Control: Start/stop recording, leave calls, and manage media
• Real-time Data: Stream transcriptions, media, and events during meetings
• Post-Meeting Analysis: Access transcripts, chat messages, intelligence, and logs
• Audio Output: Send audio to the bot for playback in meetings

​

Bot Lifecycle

1. ready - Bot is created and ready to join
2. joining_call - Bot is connecting to the meeting
3. in_waiting_room - Bot is in the waiting room
4. in_call_not_recording - Bot joined but not yet recording
5. recording_permission_allowed - Permission granted to record
6. recording_permission_denied - Permission denied to record
7. in_call_recording - Bot is actively recording
8. recording_done - Recording completed
9. call_ended - Meeting has ended
10. done - All processing complete
11. analysis_done - Analysis completed successfully
12. analysis_failed - Analysis failed
13. fatal - Unrecoverable error occurred
14. media_expired - Media files have expired

​

Getting Started

import { Recall } from '@recall.ai/sdk';

const client = new Recall({
  apiKey: 'your-api-key',
  region: 'us-west-2'
});

// Access bot methods
const bot = await client.bot.create({
  meeting_url: 'https://zoom.us/j/123456789'
});

​

Available Methods

• bot.create() - Create a new bot
• bot.list() - List all bots with filters
• bot.retrieve() - Get bot details
• bot.updateScheduledBot() - Update a scheduled bot
• bot.deleteScheduledBot() - Delete a scheduled bot
• bot.leaveCall() - Make bot leave the call
• bot.getTranscript() - Get meeting transcript
• bot.listChatMessages() - Get chat messages
• bot.getBotIntellienge() - Get AI-generated insights
• bot.getBotLogs() - Get bot activity logs
• bot.outputAudio() - Send audio to the bot
• bot.stopRecording() - Stop recording
• bot.deleteBotMedia() - Delete bot media files