SkribbyClient

constructor

Creates a new Skribby Client.

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

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

Methods

createBot

Create a new Meeting Bot which will join the meeting right away.

Parameters

This method expects an object of options which is identical to the ones in the REST API Documentation. Please refer to the Create Bot Endpoint for all options.

Returns

MeetingBot

Example

Copyawait client.createBot({
    bot_name: 'My Meeting Bot',
    meeting_url: 'https://meet.google.com/abc-defg-hij',
    service: 'gmeet',
    transcription_model: 'whisper',
    custom_metadata: {
        request_id: 'req_123',
        customer_id: 'acme-42',
    },
});

scheduleBot

Schedule a Meeting Bot for later to join.

Parameters

This method expects an object of options which is identical to the ones in the REST API Documentation. Please refer to the Create Bot Endpoint for all options. Additionally, scheduled_for is required for this method.

Returns

MeetingBot

Example

Copyawait client.scheduleBot({
  bot_name: "My Meeting Bot",
  meeting_url: "https://meet.google.com/abc-defg-hij",
  service: "gmeet",
  transcription_model: "whisper",
  scheduled_for: new Date(new Date().getTime() + 5 * 60000); // Join in 5 minutes
});

updateBot

Update an existing Meeting Bot.

Parameters

This method expects an object of options which is identical to the ones in the REST API Documentation. Please refer to the Update Bot Endpoint for all options.

Returns

MeetingBot

Example

Copyawait client.updateBot('123456', {
    bot_name: 'Updated Bot Name',
    scheduled_start_time: new Date(new Date().getTime() + 10 * 60000),
    custom_metadata: {
        request_id: 'req_456',
        customer_id: 'acme-42',
    },
});

getScheduledBots

Fetch all scheduled bots.

Returns

MeetingBot[]

Example

Copyawait client.getScheduledBots();

getBotById

Fetch a bot with a specific ID.

Parameters

Returns

MeetingBot

Example

Copyawait client.getBotById('123456');

createRecording

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 for all options.

Returns

Recording

Example

Copyawait client.createRecording({
    // recording options
});

getRecordingById

Fetch a recording with a specific ID.

Parameters

Returns

Recording

Example

Copyawait client.getRecordingById('123456');

apiRequest

All API requests from this package happens through this method.
This is made available in case new functionalities are provided on the REST API but not made available in the SDK yet.

Parameters

Throws

If an API call has failed, then we'll throw an error depending on status code.
Below is a list of predefined custom errors to make handling them easier:

• UnauthorizedError (401) - Provided API Key is invalid
• NotFoundError (404) - Requested entity not found
• UnprocessableEntityError (422) - Validation has failed (eg. required parameters were not provided)
• ApiRequestError - Global catch for other uncommon errors

The first 3 errors extend the ApiRequestError. So if you want a global catch you can simply use the ApiRequestError. All errors will include the following properties:

• status
• statusText
• responseBody
• url
• method

Returns

Object data returned from the endpoint.