Skribby

https://skribby.io/docs
Admin
Skribby is an API-first platform for deploying meeting bots into Zoom, Microsoft Teams, and Google...
Tokens:43,846
Snippets:482
Trust Score:4.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Skribby TypeScript SDK

Source: https://skribby.io/docs/guides/quickstart.md

Install the Skribby SDK for Node.js or TypeScript projects using npm.

```bash
npm install @skribby/sdk
```

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

### Install Skribby SDK

Source: https://skribby.io/docs/ts-sdk/index.md

Install the Skribby SDK package using npm. This command is required before using the SDK in your project.

```bash
npm i @skribby/sdk
```

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

### Start Event Structure

Source: https://skribby.io/docs/guides/realtime-transcription.md

The 'start' event is sent when the meeting bot has joined and begun recording, indicating that transcriptions will commence.

```json
{
    "type": "start"
}
```

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

### Create a Meeting Bot

Source: https://skribby.io/docs/ts-sdk/examples.md

This example shows how to initialize the Skribby client and create a new meeting bot with specified configurations.

```APIDOC
## Create a Meeting Bot

### Description
Initializes the Skribby client and creates a new meeting bot.

### Method
`client.createBot(options)`

### Parameters
#### Request Body
- **bot_name** (string) - Required - The name of the bot.
- **meeting_url** (string) - Required - The URL of the meeting.
- **service** (string) - Required - The meeting service (e.g., 'gmeet').
- **transcription_model** (string) - Required - The transcription model to use.
- **custom_metadata** (object) - Optional - Custom metadata for the bot.
  - **request_id** (string) - Optional - A unique request identifier.
  - **customer_id** (string) - Optional - The customer identifier.

### Request Example
```typescript
import { createClient } from '@skribby/sdk';

const client = createClient({
    api_key: 'SKRIBBY_API_KEY',
});

const bot = await client.createBot({
    bot_name: 'My Meeting Bot',
    meeting_url: 'https://meet.google.com/abc-defg-hij',
    service: 'gmeet',
    transcription_model: 'groq/whisper-large-v3-turbo',
    custom_metadata: {
        request_id: 'req_123',
        customer_id: 'acme-42',
    },
});
```
```

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

### GET Bot Pricing Request Example

Source: https://skribby.io/docs/rest-api/bot-operations/getbotpricing.md

This JSON structure represents a successful response for retrieving bot pricing. It includes details on base rates, transcription costs, add-ons, and the total pricing breakdown.

```json
{
    "id": "",
    "currency": "USD",
    "base": {
        "rate_per_hour": 0
    },
    "transcription": {
        "model": "",
        "rate_per_hour": 0,
        "byok": false
    },
    "addons": [
        {
            "name": "video",
            "rate_per_hour": 0
        }
    ],
    "total": {
        "rate_per_hour": 0,
        "amount": ""
    }
}
```

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

### POST /recording

Source: https://skribby.io/docs/rest-api.md

Creates a new recording. This endpoint initiates the process of starting a new recording session.

```APIDOC
## POST /recording

### Description
Creates a new recording. This endpoint initiates the process of starting a new recording session.

### Method
POST

### Endpoint
/recording
```

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

### Quick Start: Create a Meeting Bot

Source: https://skribby.io/docs/ts-sdk/index.md

Initialize the Skribby client and create a new meeting bot. Ensure you replace 'SKRIBBY_API_KEY' with your actual API key. This snippet demonstrates basic bot creation with essential parameters.

```typescript
import { createClient } from '@skribby/sdk';

const client = createClient({
    api_key: 'SKRIBBY_API_KEY',
});

const bot = await client.createBot({
    bot_name: 'My Meeting Bot',
    meeting_url: 'https://meet.google.com/abc-defg-hij',
    service: 'gmeet',
    transcription_model: 'groq/whisper-large-v3-turbo',
    custom_metadata: {
        request_id: 'req_123',
        customer_id: 'acme-42',
    },
});
```

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

### Listen to Realtime Transcription

Source: https://skribby.io/docs/ts-sdk/examples.md

Demonstrates how to get a real-time transcription client from a bot and listen for transcription segments.

```APIDOC
## Listen to Realtime Transcription

### Description
Obtains a real-time client from a bot and listens for incoming transcription segments. Requires a transcription model that supports real-time.

### Method
`bot.getRealtimeClient()`
`realtimeClient.on(event, listener)`
`realtimeClient.connect()`

### Parameters
#### `realtimeClient.on` Event Listener
- **event** (string) - 'ts' for transcription segments.
- **listener** (function) - Callback function that receives a `segment` object.
  - **segment.speaker_name** (string) - The name of the speaker.
  - **segment.transcript** (string) - The transcribed text.
  - **realtimeClient.transcript** (array) - An array of all transcription segments so far.

### Request Example
```typescript
import { createClient } from '@skribby/sdk';

const client = createClient({
    api_key: 'SKRIBBY_API_KEY',
});

(async () => {
    const bot = await client.createBot({
        bot_name: 'My Meeting Bot',
        meeting_url: 'https://meet.google.com/abc-defg-hij',
        service: 'gmeet',
        transcription_model: 'deepgram/nova-2-realtime',
    });

    const realtimeClient = bot.getRealtimeClient();
    realtimeClient.on('ts', (segment) => {
        console.log(`${segment.speaker_name} said: ${segment.transcript}`);
        console.log('Transcript so far:', realtimeClient.transcript);
    });
    await realtimeClient.connect();
})();
```
```

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

### Export Recording to S3 with TypeScript

Source: https://skribby.io/docs/ts-sdk/recipes.md

Move meeting assets to your own cloud storage as soon as they are ready. This example downloads the recording from Skribby and uploads it to an S3 bucket.

```typescript
import { S3Client, PutObjectCommand } from '@aws-sdk/client-s3';
import axios from 'axios';

const s3 = new S3Client({});

async function exportToS3(botId: string) {
    const bot = await skribby.getBotById(botId);

    if (bot.data.recording_url) {
        // Download the WebM file from Skribby
        const response = await axios.get(bot.data.recording_url, {
            responseType: 'arraybuffer',
        });

        // Upload to your S3 bucket
        await s3.send(
            new PutObjectCommand({
                Bucket: 'my-meeting-recordings',
                Key: `${botId}.webm`,
                Body: response.data,
                ContentType: 'video/webm',
            }),
        );

        console.log('Export complete!');

        // Optional: Delete from Skribby to save on storage/privacy
        await bot.delete();
    }
}
```

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

### Get Realtime Client (with audio)

Source: https://skribby.io/docs/ts-sdk/api-reference/MeetingBot.md

Obtain a RealtimeClient to connect to the bot's websocket server for live updates and interaction. This client includes audio streaming capabilities if available.

```typescript
// Get realtime client with audio streaming (if available)
const realtimeClient = bot.getRealtimeClient();
realtimeClient.on('ts', (segment) => {
    console.log(`${segment.speaker_name} said: ${segment.transcript}`);

    // Full transcript so far (array of segments)
    console.log('Transcript so far:', realtimeClient.transcript);
});

// Listen to audio data
realtimeClient.on('audio', (buffer: Buffer) => {
    // buffer is 16-bit PCM audio at 16kHz sample rate
});

await realtimeClient.connect();
```

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

### API Request with Legacy Alias

Source: https://skribby.io/docs/guides/transcription-models.md

Example of an API request using a legacy alias for the transcription model.

```json
{
    "transcription_model": "whisper"
    // ...
}
```

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

### GET /recording/{id}

Source: https://skribby.io/docs/rest-api.md

Retrieves information about a specific recording using its ID. This allows you to fetch details of an existing recording.

```APIDOC
## GET /recording/{id}

### Description
Retrieves information about a specific recording using its ID. This allows you to fetch details of an existing recording.

### Method
GET

### Endpoint
/recording/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the recording.
```

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

### Get Bot Pricing

Source: https://skribby.io/docs/ts-sdk/api-reference/MeetingBot.md

Fetch pricing details for the bot. The `amount` property is null while the bot is in progress and becomes a number upon completion.

```typescript
const pricing = await bot.getPricing();

console.log(pricing.total.rate_per_hour);
console.log(pricing.total.amount); // null while in progress, number when finished
```

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

### API Request with Semantic Alias

Source: https://skribby.io/docs/guides/transcription-models.md

Example of an API request using a semantic alias, such as 'soniox/latest', which points to the latest model.

```json
{
    "transcription_model": "soniox/latest"
    // ...
}
```

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

### Successful Recording Creation Response (200)

Source: https://skribby.io/docs/rest-api/recording-operations/createrecording.md

This is an example of a successful response when a recording is created. It includes details about the recording's status and transcription.

```json
{
    "id": "",
    "status": "transcribing",
    "webhook_url": "",
    "recording_url": "",
    "recording_available_until": "",
    "lang": "",
    "detected_lang": "",
    "transcript": [
        {
            "start": 0,
            "end": 0,
            "speaker": 0,
            "speaker_name": "",
            "potential_speaker_names": "",
            "confidence": 0,
            "transcript": "",
            "utterances": [
                {}
            ]
        }
    ],
    "transcription_model": "",
    "transcription_model_key": "",
    "events": [
        {
            "event": "",
            "data": {
                "old_status": "",
                "new_status": ""
            },
            "created_at": ""
        }
    ],
    "profanity_filter": false,
    "custom_vocabulary": [
        ""
    ],
    "created_at": ""
}
```

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

### Listen to Realtime Events with `on`

Source: https://skribby.io/docs/ts-sdk/api-reference/RealtimeClient.md

Use the `on` method to register callbacks for various real-time events. It supports type-safe event handling with `RealtimeEventMap`. You can listen to specific events like 'start' or 'ts', or use 'raw' to receive all messages.

```typescript
realtimeClient.on('start', () => {
    console.log('Bot has started!');
});
```

```typescript
realtimeClient.on('ts', (segment) => {
    console.log(`${segment.speaker_name} said: ${segment.transcript}`);

    // Full transcript so far (array of segments)
    console.log('Transcript so far:', realtimeClient.transcript);
});
```

```typescript
// Listen to all raw messages
realtimeClient.on('raw', (data) => {
    console.log('Raw message:', data);
});
```

```typescript
// Listen to audio data (requires audio_url to be provided)
realtimeClient.on('audio', (buffer: Buffer) => {
    // buffer is 16-bit PCM audio at 16kHz sample rate
    console.log('Received audio chunk:', buffer.length, 'bytes');
});
```

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

### Example 403 Plan Limit Error Response

Source: https://skribby.io/docs/guides/api-debugging.md

This JSON response indicates that you have exceeded a plan limit, such as concurrent bots or monthly hours. Review your plan's usage and limits.

```json
{
    "message": "You have reached the limit of concurrent meeting bots for your plan."
}
```

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

### Example Scheduled Bot Response

Source: https://skribby.io/docs/rest-api/bot-operations/getscheduledbots.md

This JSON structure represents a single scheduled bot object returned when the GET /bot/scheduled endpoint is called successfully. It details various properties of the bot, its scheduling, and configuration.

```json
[
    {
        "id": "",
        "status": "scheduled",
        "stop_reason": "invalid_meeting_url",
        "service": "gmeet",
        "scheduled_for": "",
        "time_limit": "",
        "stop_options": {
            "time_limit": 0,
            "waiting_room_timeout": 0,
            "last_person_detection": 0,
            "empty_meeting_timeout": 0,
            "silence_detection": 0
        },
        "bot_name": "",
        "bot_avatar": "",
        "meeting_url": "",
        "webhook_url": "",
        "custom_metadata": {},
        "recording_url": "",
        "recording_available_until": "",
        "websocket_url": "",
        "websocket_read_only_url": "",
        "websocket_audio_url": "",
        "video": false,
        "lang": "",
        "detected_lang": "",
        "transcript": [
            {
                "start": 0,
                "end": 0,
                "speaker": 0,
                "speaker_name": "",
                "potential_speaker_names": "",
                "confidence": 0,
                "transcript": "",
                "utterances": [
                    {}
                ]
            }
        ],
        "transcription_model": "",
        "transcription_model_key": "",
        "participants": [
            {
                "name": "",
                "avatar": "",
                "first_seen_at": "",
                "events": [
                    {
                        "type": "started-speaking",
                        "timestamp": 0
                    }
                ]
            }
        ],
        "events": [
            {
                "event": "",
                "data": {
                    "old_status": "",
                    "new_status": ""
                },
                "created_at": ""
            }
        ],
        "profanity_filter": false,
        "custom_vocabulary": [
            ""
        ],
        "created_at": "",
        "finished_at": ""
    }
]
```

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

### Create Bot with Realtime Audio and Listen to Audio Events

Source: https://skribby.io/docs/guides/realtime-transcription.md

Use the SDK to create a bot with `realtime_audio` enabled. Obtain the realtime client, which includes audio by default, and listen for 'audio' events to process the incoming audio buffer.

```typescript
// Create bot with realtime audio enabled
const bot = await client.createBot({
    transcription_model: 'none',
    meeting_url: 'https://meet.google.com/abc-defg-hij',
    service: 'gmeet',
    bot_name: 'My Audio Bot',
    realtime_audio: true,
});

// Get the realtime client (includes audio by default)
const realtimeClient = bot.getRealtimeClient();

// Listen to audio events
realtimeClient.on('audio', (buffer: Buffer) => {
    // buffer is 16-bit PCM audio at 16kHz sample rate
    processAudio(buffer);
});

await realtimeClient.connect();

// Check audio connection status
console.log('Audio connected:', realtimeClient.audioConnected);
```

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

### Customize Bot Stop Options

Source: https://skribby.io/docs/guides/best-practices.md

Adjust Skribby's default stop options to customize when the bot leaves a meeting. This example shows how to configure longer waits for meeting starts while ensuring the bot leaves promptly after participants depart.

```json
{
    "stop_options": {
        "empty_meeting_timeout": 10,
        "last_person_detection": 2
    }
}
```

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

### Connect to WebSocket Servers

Source: https://skribby.io/docs/ts-sdk/api-reference/RealtimeClient.md

Initiate the connection to the websocket server(s) using the `connect` method. If an `audio_url` was provided during client initialization, this method establishes two parallel WebSocket connections for transcription and audio data.

```typescript
await realtimeClient.connect();
```

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

### Create Realtime Client Instance

Source: https://skribby.io/docs/ts-sdk/api-reference/createRealtimeClient.md

Instantiate a RealtimeClient for connecting to transcription events. Use the optional second parameter to also stream audio data if your bot supports it.

```typescript
// Without audio streaming
const realtimeClient = createRealtimeClient('wss://ws.example.org/123456');

// With audio streaming
const realtimeClientWithAudio = createRealtimeClient(
    'wss://ws.example.org/123456',
    'wss://ws.example.org/123456/audio',
);
```

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

### Get Bot ID

Source: https://skribby.io/docs/ts-sdk/api-reference/MeetingBot.md

Access the unique identifier for a meeting bot.

```typescript
console.log(bot.id);
```

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

### SkribbyClient Constructor

Source: https://skribby.io/docs/ts-sdk/api-reference/SkribbyClient.md

Initializes a new SkribbyClient instance with provided options.

```APIDOC
## constructor

Creates a new Skribby Client.

### Parameters

| Parameter | Default | Description |
| --- | --- | --- |
| `options` | _required_ | Options when creating a new client |
| `options.api_key` | _required_ | Skribby API Key found on [the platform](https://platform.skribby.io?to=api-keys) |
| `options.region` | `'eu'` | The region where your account and data are hosted (`'eu'` or `'jp'`). The base URL will be derived automatically based on this value. |
| `options.base_url` | `'https://platform.skribby.io/api/v1'` | Optionally override the base URL if necessary (e.g., when mocking tests or using a specialized environment). |

### Example

```ts
import { SkribbyClient } from '@skribby/sdk';

const client = new SkribbyClient({
    api_key: 'SKRIBBY_API_KEY',
    region: 'jp', // defaults to 'eu'
});
```
```

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

### Instantiate Recording Instance

Source: https://skribby.io/docs/ts-sdk/api-reference/Recording.md

Creates a new Recording instance. Typically, this is handled internally by the SkribbyClient when creating or fetching recordings.

```typescript
import { Recording } from '@skribby/sdk';

const recording = new Recording(client, {
    id: '3c09b2aa-6708-42c1-8145-aa55ee223613',
    status: 'completed',
    recording_url: 'https://example.com',
    recording_available_until: '2019-08-24T14:15:22Z',
    transcription_model: 'groq/whisper-large-v3-turbo',
    transcription_model_key: 'groq/whisper-large-v3-turbo',
    events: [
        {
            event: 'status_update',
            data: {
                old_status: 'processing',
                new_status: 'completed',
            },
            created_at: '2019-08-24T14:15:22Z',
        },
    ],
    created_at: '2019-08-24T14:15:22Z',
});
```

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

### Started Speaking Event Structure

Source: https://skribby.io/docs/guides/realtime-transcription.md

The 'started-speaking' event is sent when the system detects a participant actively speaking.

```json
{
    "type": "started-speaking",
    "data": {
        "participantId": "John Doe",
        "participantName": "John Doe"
    }
}
```

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

### RealtimeClient Constructor

Source: https://skribby.io/docs/ts-sdk/api-reference/RealtimeClient.md

Initializes a new RealtimeClient. This client connects to a websocket server for transcription events and optionally for audio data.

```APIDOC
## constructor

Creates a new RealtimeClient to interact with realtime transcription models.
If you make use of the client, you can generate this instance automatically via [`MeetingBot.getRealtimeClient()`](./MeetingBot.md#getrealtimeclient).
If this would be used on the front-end, then you can fetch the websocket url in the back-end, forward it to the front-end and use this class directly.

### Parameters

| Parameter   | Default   | Description                                                                                                |
| ----------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `url`       | _required_ | URL to the websocket server for transcription events                                                         |
| `audio_url` | _optional_ | URL to the audio websocket server for receiving realtime audio data. Only available when the bot was created with `realtime_audio: true`. |

### Example

```ts
import { RealtimeClient } from '@skribby/sdk';

// Without audio streaming
const realtimeClient = new RealtimeClient('wss://example.org/123456');

// With audio streaming
const realtimeClientWithAudio = new RealtimeClient(
    'wss://example.org/123456',
    'wss://example.org/123456/audio',
);
```
```

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

### Access Recording Data

Source: https://skribby.io/docs/ts-sdk/api-reference/Recording.md

Gets all data associated with the recording. Dates are automatically parsed into Date objects.

```typescript
console.log(recording.data.status);
console.log(recording.data.recording_url);
console.log(recording.data.recording_available_until);
console.log(recording.data.transcription_model);
console.log(recording.data.transcription_model_key);
// ...
```

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

### Recording Constructor

Source: https://skribby.io/docs/ts-sdk/api-reference/Recording.md

Creates a recording instance to interact with this recording. You normally wouldn't need to instantiate this class manually. When creating or fetching recordings via the SkribbyClient, an instance of this class will be returned.

```APIDOC
## constructor

Creates a recording instance to interact with this recording.
You normally wouldn't need to instantiate this class manually.
When creating or fetching recordings via the [SkribbyClient](./SkribbyClient.md), an instance of this class will be returned.

### Parameters

- `client` (_required_): A [SkribbyClient](./SkribbyClient.md) instance
- `api_data` (_required_): Object containing API Data of a recording (Refer to [Get Recording Endpoint](/docs/rest-api/recording-operations/getrecording.md#recording-operations/getrecording/response&c=200))

### Example

```ts
import { Recording } from '@skribby/sdk';

const recording = new Recording(client, {
    id: '3c09b2aa-6708-42c1-8145-aa55ee223613',
    status: 'completed',
    recording_url: 'https://example.com',
    recording_available_until: '2019-08-24T14:15:22Z',
    transcription_model: 'groq/whisper-large-v3-turbo',
    transcription_model_key: 'groq/whisper-large-v3-turbo',
    events: [
        {
            event: 'status_update',
            data: {
                old_status: 'processing',
                new_status: 'completed',
            },
            created_at: '2019-08-24T14:15:22Z',
        },
    ],
    created_at: '2019-08-24T14:15:22Z',
});
```
```

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

### connect

Source: https://skribby.io/docs/ts-sdk/api-reference/RealtimeClient.md

Initiates the connection with the websocket server(s). If an `audio_url` was provided during client initialization, this method establishes both the main transcription/control connection and a separate audio data connection.

```APIDOC
## connect

### Description
Start connection with the websocket server(s). If an `audio_url` was provided to the constructor, this method establishes two parallel WebSocket connections:

- Main connection for transcription/control events
- Audio connection for receiving raw audio data

Both connections are awaited in parallel.

### Method
`connect()`

### Throws
- `Error` - If the websocket connection fails

### Returns
`Promise<void>`

### Example
```ts
await realtimeClient.connect();
```
```

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

### API Request with Official Key

Source: https://skribby.io/docs/guides/transcription-models.md

Example of an API request where the official transcription model key is provided.

```json
{
    "transcription_model": "deepgram/nova-2"
    // ...
}
```

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

### API Response with Official Key

Source: https://skribby.io/docs/guides/transcription-models.md

Example of an API response when an official transcription model key was used in the request.

```json
{
    "transcription_model": "deepgram/nova-2",
    "transcription_model_key": "deepgram/nova-2"
    // ...
}
```

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

### createClient

Source: https://skribby.io/docs/ts-sdk/api-reference/index.md

Creates a SkribbyClient instance, which serves as the primary API client for managing bots, their lifecycles, and accessing recordings and other platform resources.

```APIDOC
## createClient

### Description
Factory function to create a `SkribbyClient` instance. This client is used for bot creation, managing bot lifecycles, and accessing recordings.

### Method
Factory Function

### Parameters
This function does not take any parameters directly. Refer to `./createClient.md` for detailed instantiation information.

### Response
- **SkribbyClient** - An instance of the `SkribbyClient` class.
```

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

### Initialize SkribbyClient

Source: https://skribby.io/docs/ts-sdk/api-reference/SkribbyClient.md

Instantiate the SkribbyClient with your API key and specify the region. The base URL is automatically derived from the region, but can be overridden if needed.

```typescript
import { SkribbyClient } from '@skribby/sdk';

const client = new SkribbyClient({
    api_key: 'SKRIBBY_API_KEY',
    region: 'jp', // defaults to 'eu'
});
```

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

### Create Skribby Client with API Key

Source: https://skribby.io/docs/ts-sdk/api-reference/createClient.md

Instantiate the SkribbyClient using the createClient helper function. Requires an object with a valid 'api_key' parameter.

```typescript
const client = createClient({
    api_key: 'SKRIBBY_API_KEY',
});
```

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

### GET /bot/scheduled

Source: https://skribby.io/docs/rest-api.md

Retrieves a list of all scheduled bots. This endpoint provides an overview of bots that are set to run at a future time.

```APIDOC
## GET /bot/scheduled

### Description
Retrieves a list of all scheduled bots. This endpoint provides an overview of bots that are set to run at a future time.

### Method
GET

### Endpoint
/bot/scheduled
```

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

### Create a Skribby Bot using TypeScript SDK

Source: https://skribby.io/docs/guides/quickstart.md

This TypeScript code demonstrates how to initialize the Skribby client and create a bot. It logs the bot ID and its initial status.

```typescript
import { createClient } from '@skribby/sdk';

const skribby = createClient({
    api_key: 'YOUR_API_KEY',
    // region: 'jp', // Uncomment if your account is in the Japan region
});

async function main() {
    const bot = await skribby.createBot({
        transcription_model: 'groq/whisper-large-v3-turbo',
        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();
```

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

### GET /bot/{id}

Source: https://skribby.io/docs/rest-api.md

Retrieves information about a specific bot using its ID. This allows you to fetch details of an existing bot.

```APIDOC
## GET /bot/{id}

### Description
Retrieves information about a specific bot using its ID. This allows you to fetch details of an existing bot.

### Method
GET

### Endpoint
/bot/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the bot.
```

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

### Get Bot Pricing

Source: https://skribby.io/docs/rest-api/bot-operations/getbotpricing.md

Retrieves the pricing breakdown for a specific bot. The `total.amount` field is null during a meeting and populated after completion.

```APIDOC
## GET /bot/{id}/pricing

### Description
Retrieve the pricing breakdown for a specific bot. The `total.amount` field is null during a meeting and populated after completion.

### Method
GET

### Endpoint
`/bot/{id}/pricing`

### Parameters
#### Path Parameters
- **id** (string) - Yes - Bot ID

### Responses
#### Success Response (200)
Bot pricing retrieved successfully
- **id** (string) - 
- **currency** (string) - 
- **base** (object) - 
  - **rate_per_hour** (number) - 
- **transcription** (object) - 
  - **model** (string) - 
  - **rate_per_hour** (number) - 
  - **byok** (boolean) - 
- **addons** (array) - 
  - **name** (string) - 
  - **rate_per_hour** (number) - 
- **total** (object) - 
  - **rate_per_hour** (number) - 
  - **amount** (string) - 

#### Response Example (200)
```json
{
    "id": "",
    "currency": "USD",
    "base": {
        "rate_per_hour": 0
    },
    "transcription": {
        "model": "",
        "rate_per_hour": 0,
        "byok": false
    },
    "addons": [
        {
            "name": "video",
            "rate_per_hour": 0
        }
    ],
    "total": {
        "rate_per_hour": 0,
        "amount": ""
    }
}
```

#### Error Response (401)
Unauthorized - Invalid API key

#### Error Response (404)
Bot not found
```

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

### Upload Audio from URL

Source: https://skribby.io/docs/guides/recordings-upload.md

Provide a URL if your audio file is hosted online. The API will fetch and transcribe the audio. Specify the transcription model and language.

```bash
curl -X POST https://platform.skribby.io/api/v1/recording \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recording_url": "https://example.com/audio.mp3",
    "transcription_model": "groq/whisper-large-v3-turbo",
    "lang": "en"
  }'
```

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

### Fetch Bot Pricing

Source: https://skribby.io/docs/ts-sdk/examples.md

Demonstrates how to retrieve pricing information for a specific bot, either via the bot instance or directly using the client.

```APIDOC
## Fetch Bot Pricing

### Description
Retrieves pricing details for a given bot. This can be done either by first fetching the bot object and then its pricing, or by directly calling a client method with the bot ID.

### Method
`bot.getPricing()`
`client.getBotPricing(botId)`

### Parameters
#### `client.getBotPricing` Parameters
- **botId** (string) - Required - The unique identifier of the bot.

### Response
#### Success Response (200)
- **total** (object) - Pricing summary.
  - **rate_per_hour** (number) - The hourly rate.
  - **amount** (number | null) - The total cost (null if still in progress).
- **currency** (string) - The currency of the pricing (e.g., 'USD').

### Request Example
```typescript
// Via bot instance
const bot = await client.getBotById('3c09b2aa-6708-42c1-8145-aa55ee223613');

if (bot) {
    const pricing = await bot.getPricing();
    console.log(pricing.total.rate_per_hour);
    console.log(pricing.total.amount);
}

// Or directly via client + bot id
const pricing = await client.getBotPricing(
    '3c09b2aa-6708-42c1-8145-aa55ee223613',
);
console.log(pricing.currency);
```
```

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

### on

Source: https://skribby.io/docs/ts-sdk/api-reference/RealtimeClient.md

Creates a new event listener to handle real-time events. It supports type-safe event handling using `RealtimeEventMap` and allows listening to specific events or all raw messages.

```APIDOC
## on

### Description
Create a new event listener with a callback to handle events. This method is fully typed with `RealtimeEventMap` for type-safe event handling.

### Method
`on(eventName: string, callback: function)`

### Parameters
#### Path Parameters
- **eventName** (string) - Required - Event name to listen to. Refer to the [Realtime Core Concepts](../../guides/realtime-transcription.md#websocket-events) for all available events. You can also use `raw` to receive all raw messages.
- **callback** (function with 1 parameter) - Required - Callback when event has been triggered. Refer to the [Realtime Core Concepts](../../guides/realtime-transcription.md#websocket-events) for returned data per event. The callback will contain the `data` segment, if `data` is not provided the returned parameter will be `undefined`.

### Returns
`void`

### Example
```ts
realtimeClient.on('start', () => {
    console.log('Bot has started!');
});

realtimeClient.on('ts', (segment) => {
    console.log(`${segment.speaker_name} said: ${segment.transcript}`);

    // Full transcript so far (array of segments)
    console.log('Transcript so far:', realtimeClient.transcript);
});

// Listen to all raw messages
realtimeClient.on('raw', (data) => {
    console.log('Raw message:', data);
});

// Listen to audio data (requires audio_url to be provided)
realtimeClient.on('audio', (buffer: Buffer) => {
    // buffer is 16-bit PCM audio at 16kHz sample rate
    console.log('Received audio chunk:', buffer.length, 'bytes');
});
```
```

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

### Retrieve Scheduled Bots

Source: https://skribby.io/docs/rest-api/bot-operations/getscheduledbots.md

This endpoint retrieves all scheduled bots that have not yet started. It returns an array of bot objects with the status 'scheduled'.

```APIDOC
## GET /bot/scheduled

### Description
Retrieve all scheduled bots that haven't started yet. Returns an array of bot objects with status "scheduled".

### Method
GET

### Endpoint
/bot/scheduled

### Responses
#### Success Response (200)
Scheduled bots retrieved successfully.

##### application/json
```json
[
    {
        "id": "",
        "status": "scheduled",
        "stop_reason": "invalid_meeting_url",
        "service": "gmeet",
        "scheduled_for": "",
        "time_limit": "",
        "stop_options": {
            "time_limit": 0,
            "waiting_room_timeout": 0,
            "last_person_detection": 0,
            "empty_meeting_timeout": 0,
            "silence_detection": 0
        },
        "bot_name": "",
        "bot_avatar": "",
        "meeting_url": "",
        "webhook_url": "",
        "custom_metadata": {},
        "recording_url": "",
        "recording_available_until": "",
        "websocket_url": "",
        "websocket_read_only_url": "",
        "websocket_audio_url": "",
        "video": false,
        "lang": "",
        "detected_lang": "",
        "transcript": [
            {
                "start": 0,
                "end": 0,
                "speaker": 0,
                "speaker_name": "",
                "potential_speaker_names": "",
                "confidence": 0,
                "transcript": "",
                "utterances": [
                    {}
                ]
            }
        ],
        "transcription_model": "",
        "transcription_model_key": "",
        "participants": [
            {
                "name": "",
                "avatar": "",
                "first_seen_at": "",
                "events": [
                    {
                        "type": "started-speaking",
                        "timestamp": 0
                    }
                ]
            }
        ],
        "events": [
            {
                "event": "",
                "data": {
                    "old_status": "",
                    "new_status": ""
                },
                "created_at": ""
            }
        ],
        "profanity_filter": false,
        "custom_vocabulary": [
            ""
        ],
        "created_at": "",
        "finished_at": ""
    }
]
```
#### Error Response (401)
Unauthorized - Invalid API key

##### application/json
```json
{
    "message": ""
}
```
```

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

### API Response with Legacy Alias

Source: https://skribby.io/docs/guides/transcription-models.md

Example of an API response when a legacy alias was used in the request, showing the resolved official key.

```json
{
    "transcription_model": "whisper",
    "transcription_model_key": "groq/whisper-large-v3-turbo"
    // ...
}
```

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

### createRealtimeClient

Source: https://skribby.io/docs/ts-sdk/api-reference/index.md

Creates a RealtimeClient instance, designed for low-latency streaming transcription workflows and receiving live event updates.

```APIDOC
## createRealtimeClient

### Description
Factory function to create a `RealtimeClient` instance. This client is optimized for low-latency streaming transcription and real-time event handling.

### Method
Factory Function

### Parameters
This function does not take any parameters directly. Refer to `./createRealtimeClient.md` for detailed instantiation information.

### Response
- **RealtimeClient** - An instance of the `RealtimeClient` class.
```

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

### Get Bot

Source: https://skribby.io/docs/rest-api/bot-operations/getbot.md

Retrieves detailed information about a specific bot. This includes its status, meeting details, transcript, participants, and any lifecycle events that have occurred.

```APIDOC
## GET /bot/{id}

### Description
Retrieve information about a specific bot, including its current status,
transcript (if available), participants, and lifecycle events.

### Method
GET

### Endpoint
/bot/{id}

### Parameters
#### Path Parameters
- **id** (string) - Yes - Bot ID

#### Query Parameters
- **with-speaker-events** (boolean) - No - Include speaker events in participant data

### Responses
#### Success Response (200)
Bot information retrieved successfully
- **id** (string) - 
- **status** (string) - 
- **stop_reason** (string) - 
- **service** (string) - 
- **scheduled_for** (string) - 
- **time_limit** (string) - 
- **stop_options** (object) - 
- **bot_name** (string) - 
- **bot_avatar** (string) - 
- **meeting_url** (string) - 
- **webhook_url** (string) - 
- **custom_metadata** (object) - 
- **recording_url** (string) - 
- **recording_available_until** (string) - 
- **websocket_url** (string) - 
- **websocket_read_only_url** (string) - 
- **websocket_audio_url** (string) - 
- **video** (boolean) - 
- **lang** (string) - 
- **detected_lang** (string) - 
- **transcript** (array) - 
- **transcription_model** (string) - 
- **transcription_model_key** (string) - 
- **participants** (array) - 
- **events** (array) - 
- **profanity_filter** (boolean) - 
- **custom_vocabulary** (array) - 
- **created_at** (string) - 
- **finished_at** (string) - 

#### Response Example
```json
{
    "id": "",
    "status": "scheduled",
    "stop_reason": "invalid_meeting_url",
    "service": "gmeet",
    "scheduled_for": "",
    "time_limit": "",
    "stop_options": {
        "time_limit": 0,
        "waiting_room_timeout": 0,
        "last_person_detection": 0,
        "empty_meeting_timeout": 0,
        "silence_detection": 0
    },
    "bot_name": "",
    "bot_avatar": "",
    "meeting_url": "",
    "webhook_url": "",
    "custom_metadata": {},
    "recording_url": "",
    "recording_available_until": "",
    "websocket_url": "",
    "websocket_read_only_url": "",
    "websocket_audio_url": "",
    "video": false,
    "lang": "",
    "detected_lang": "",
    "transcript": [
        {
            "start": 0,
            "end": 0,
            "speaker": 0,
            "speaker_name": "",
            "potential_speaker_names": "",
            "confidence": 0,
            "transcript": "",
            "utterances": [
                {}
            ]
        }
    ],
    "transcription_model": "",
    "transcription_model_key": "",
    "participants": [
        {
            "name": "",
            "avatar": "",
            "first_seen_at": "",
            "events": [
                {
                    "type": "started-speaking",
                    "timestamp": 0
                }
            ]
        }
    ],
    "events": [
        {
            "event": "",
            "data": {
                "old_status": "",
                "new_status": ""
            },
            "created_at": ""
        }
    ],
    "profanity_filter": false,
    "custom_vocabulary": [
        ""
    ],
    "created_at": "",
    "finished_at": ""
}
```

#### Error Response (401)
Unauthorized - Invalid API key
- **message** (string) - 

#### Error Response (404)
Bot not found
- **message** (string) - 
```

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

### createRecording

Source: https://skribby.io/docs/ts-sdk/api-reference/SkribbyClient.md

Creates a new recording by accepting an options object. For a detailed list of available options, please refer to the Create Recording Endpoint documentation.

```APIDOC
## createRecording

### Description
Create a new Recording.

### Parameters
This method expects an object of options which is identical to the ones in the REST API Documentation. Please refer to the [Create Recording Endpoint](/docs/rest-api/recording-operations/createrecording.md) for all options.

### Returns
[`Recording`](./Recording.md)

### Example
```ts
await client.createRecording({
    // recording options
});
```
```

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

### POST /bot

Source: https://skribby.io/docs/rest-api.md

Creates a new bot. This endpoint initiates the process of setting up a new bot within the Skribby platform.

```APIDOC
## POST /bot

### Description
Creates a new bot. This endpoint initiates the process of setting up a new bot within the Skribby platform.

### Method
POST

### Endpoint
/bot
```

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

### API Response with Semantic Alias

Source: https://skribby.io/docs/guides/transcription-models.md

Example of an API response when a semantic alias was used, showing the resolved official key for the latest model.

```json
{
    "transcription_model": "soniox/latest",
    "transcription_model_key": "soniox/stt-async-v5"
    // ...
}
```

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

### Participant Tracked Event Structure

Source: https://skribby.io/docs/guides/realtime-transcription.md

The 'participant-tracked' event is emitted when a new participant is detected in the meeting, including all existing participants at the meeting's start.

```json
{
    "type": "participant-tracked",
    "data": {
        "participantId": "John Doe",
        "participantName": "John Doe"
    }
}
```

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

### Get Bot Data

Source: https://skribby.io/docs/ts-sdk/api-reference/MeetingBot.md

Retrieve all available data for a meeting bot, including transcription, participants, and recording URL. Dates are returned as Date objects.

```typescript
console.log(bot.data.transcription);
console.log(bot.data.participants);
console.log(bot.data.recording_url);
console.log(bot.data.transcription_model);
console.log(bot.data.transcription_model_key);
// ...
```

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

### Basic Agentic Capabilities

Source: https://skribby.io/docs/ts-sdk/examples.md

Shows how to send messages and commands through the real-time client based on transcriptions.

```APIDOC
## Basic Agentic Capabilities

### Description
Utilizes the real-time client to send chat messages or control the bot based on detected speech. Requires a transcription model that supports real-time.

### Method
`realtimeClient.send(command, payload)`

### Parameters
#### `realtimeClient.send` Command Examples
- **command**: 'chat-message'
  - **payload**: object
    - **content** (string) - The message content to send.
- **command**: 'stop'
  - **payload**: None

### Request Example
```typescript
import { createClient } from '@skribby/sdk';

const client = createClient({
    api_key: 'SKRIBBY_API_KEY',
});

(async () => {
    const bot = await client.createBot({
        bot_name: 'My Meeting Bot',
        meeting_url: 'https://meet.google.com/abc-defg-hij',
        service: 'gmeet',
        transcription_model: 'deepgram/nova-2-realtime',
    });

    const realtimeClient = bot.getRealtimeClient();
    realtimeClient.on('ts', (segment) => {
        if (segment.transcript.toLowerCase().includes('hello')) {
            realtimeClient.send('chat-message', {
                content: 'Hello back!',
            });
        }

        if (segment.transcript.toLowerCase().includes('end the meeting')) {
            realtimeClient.send('stop');
        }
    });
    await realtimeClient.connect();
})();
```
```

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

### GET /bot/{id}/pricing

Source: https://skribby.io/docs/rest-api.md

Retrieves the pricing details for a specific bot using its ID. This endpoint provides information on costs associated with the bot.

```APIDOC
## GET /bot/{id}/pricing

### Description
Retrieves the pricing details for a specific bot using its ID. This endpoint provides information on costs associated with the bot.

### Method
GET

### Endpoint
/bot/{id}/pricing

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the bot.
```

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

### Create Recording Request Body (application/json)

Source: https://skribby.io/docs/rest-api/recording-operations/createrecording.md

Use this structure when providing a URL for the recording. Ensure 'recording_url' is provided.

```json
{
    "transcription_model": "",
    "recording_url": "",
    "meeting_bot_id": "",
    "lang": "",
    "webhook_url": "",
    "store_recording_for_1_year": false,
    "profanity_filter": false,
    "custom_vocabulary": [
        ""
    ],
    "transcription_credentials": ""
}
```

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

### Get Realtime Client Without Audio Streaming

Source: https://skribby.io/docs/guides/realtime-transcription.md

Instantiate a realtime client specifically for transcriptions only by passing `true` to `getRealtimeClient()`. This omits audio streaming.

```typescript
// Get realtime client WITHOUT audio streaming
const transcriptOnlyClient = bot.getRealtimeClient(true);
await transcriptOnlyClient.connect();
```

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

### Create Recording with SkribbyClient

Source: https://skribby.io/docs/ts-sdk/api-reference/SkribbyClient.md

Use this method to create a new recording. Refer to the REST API documentation for a full list of recording options.

```typescript
await client.createRecording({
    // recording options
});
```

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

### Retrieve Bot Data with Speaker Events

Source: https://skribby.io/docs/guides/speaker-timelines.md

Append the `with-speaker-events=true` query parameter to the `GET /api/v1/bot/{id}` endpoint to include the full speaking timeline in the response.

```http
GET /api/v1/bot/{id}?with-speaker-events=true
```

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

### Configure Bot Stop Options

Source: https://skribby.io/docs/guides/bot-lifecycle.md

Use the `stop_options` object when creating a bot to define various timeouts and limits that determine when the bot will automatically stop. All durations are in minutes.

```json
{
  "transcription_model": "openai/whisper-large-v3",
  "meeting_url": "https://meet.google.com/osk-sbwe-nff",
  "service": "gmeet",
  "bot_name": "My Meeting Bot",
  "stop_options": {
    "empty_meeting_timeout": 10,
    "last_person_detection": 5,
    "waiting_room_timeout": 10,
    "time_limit": 120,
    "silence_detection": 0
  }
}
```
Tokens:
Raw