Quickstart

Get your first Skribby bot into a meeting in under 5 minutes.

1. Get your API Key

1. Log in to the Skribby Dashboard.
2. Navigate to the API Keys section.
3. Generate a new API key and keep it secure.

2. Create your first bot

The most basic way to interact with Skribby is via our REST API. You can send a bot to any Google Meet, Zoom, or Microsoft Teams meeting with a single POST request.

Replace YOUR_API_KEY with the key from step 1 and MEETING_URL with a valid meeting link.

Copycurl -X POST 'https://platform.skribby.io/api/v1/bot' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "transcription_model": "whisper",
    "meeting_url": "MEETING_URL",
    "service": "gmeet",
    "bot_name": "Skribby Assistant"
  }'

What happens next?

1. Skribby spawns a bot instance.
2. The bot attempts to join the meeting URL provided.
3. Once admitted, the bot starts recording and transcribing.
4. When the meeting ends (or you stop the bot), the data is processed and stored.

3. Using the TypeScript SDK

If you are building with Node.js or TypeScript, our SDK provides a much better developer experience with full type safety.

Install

Copynpm install @skribby/sdk

Basic Usage

Copyimport { createClient } from '@skribby/sdk';

const skribby = createClient({
  api_key: 'YOUR_API_KEY'
});

async function main() {
  const bot = await skribby.createBot({
    transcription_model: 'whisper',
    meeting_url: 'https://meet.google.com/abc-defg-hij',
    service: 'gmeet',
    bot_name: 'Recording Bot'
  });

  console.log(`Bot created with ID: ${bot.id}`);
  
  // Refresh to get the latest status from the server
  await bot.refresh();
  console.log(`Current status: ${bot.data.status}`);
}

main();

4. Next Steps

Now that you've successfully deployed a bot, explore the more advanced features:

• Webhooks: Learn how to receive real-time updates when the bot joins or transcription arrives.
• Real-time Transcription: Stream text live as people speak.
• Bot Lifecycle: Understand the different states a bot goes through.