syllable-sdk

syllable-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage syllable-sdk API.

Summary

SyllableSDK:

Syllable Platform SDK

Syllable SDK gives you the power of awesome AI agentry. 🚀

Overview

The Syllable SDK provides a comprehensive set of tools and APIs to integrate powerful AI
capabilities into your communication applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllable SDK has got you covered.

Features

• Natural Language Processing (NLP): Understand and generate human language with ease.
• Machine Learning Models: Leverage pre-trained models or train your own custom models.
• Speech Recognition: Convert speech to text and vice versa.
• Data Analytics: Analyze and visualize data to gain insights.
• Integration: Seamlessly integrate with other services and platforms.

Table of Contents

• syllable-sdk
• Syllable Platform SDK
  • Overview
  • Features
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add syllable-sdk

PNPM

pnpm add syllable-sdk

Bun

bun add syllable-sdk

Yarn

yarn add syllable-sdk zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({});

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

agents

• list - Agent List
• create - Create Agent
• update - Update Agent
• getById - Get Agent By Id
• delete - Delete Agent

agents.test

• sendTestMessage - Send New Message

channels

• list - Get Channels
• delete - Delete Channel Target

channels.targets

• availableTargets - Available Targets List
• list - Get Channel Targets
• create - Assign A Channel Target
• getById - Get A Channel Target
• update - Edit Channel Target

conversations

• list - Conversations List

customMessages

• list - Custom Messages List
• create - Create Custom Message
• update - Update Custom Message
• getById - Get Custom Message By Id
• delete - Delete Custom Message

dashboards

• totalCallVolumeByWeekday - Get Total Call Volume By Weekday
• getTotalCallVolumeByHour - Get Total Call Volume By Hour
• getWeeklyCallVolumeByWeekday - Get Weekly Call Volume By Weekday
• getDailyCallVolumeByHour - Get Daily Call Volume By Hour
• getMonthlyCallVolumeByWeek - Get Monthly Call Volume By Week
• getMonthlyCallVolumeByDay - Get Monthly Call Volume By Day
• getSessionSummary - Get Session Summary
• getSessionAgents - Get Agents

directory

• list - Directory Member List
• create - Create Directory Member
• getById - Get Directory Member By Id
• update - Update Directory Member
• delete - Delete Directory Member

events

• list - Events List

prompts

• list - Prompt List
• create - Create Prompt
• update - Update Prompt
• getById - Get Prompt By Id
• delete - Delete Prompt
• promptsHistory - Get Prompt History

services

• list - Service List
• create - Create Service
• update - Update Service

sessionLabels

• getById - Get Label By Id
• create - Create Label
• list - Session Labels List

sessions

• list - Sessions List
• getById - Get A Single Session By Id
• generateSessionRecordingUrls - Generate Recording Urls
• sessionRecordingStream - Stream Recording

sessions.transcript

• getById - Get Session Transcript By Id

tools

• list - Tool List
• create - Create Tool
• update - Update Tool
• getByName - Tool Info

v1

• list - Directory Member List
• create - Create Directory Member
• getById - Get Directory Member By Id
• update - Update Directory Member
• delete - Delete Directory Member

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• agentsCreate - Create Agent
• agentsDelete - Delete Agent
• agentsGetById - Get Agent By Id
• agentsList - Agent List
• agentsTestSendTestMessage - Send New Message
• agentsUpdate - Update Agent
• channelsDelete - Delete Channel Target
• channelsList - Get Channels
• channelsTargetsAvailableTargets - Available Targets List
• channelsTargetsCreate - Assign A Channel Target
• channelsTargetsGetById - Get A Channel Target
• channelsTargetsList - Get Channel Targets
• channelsTargetsUpdate - Edit Channel Target
• conversationsList - Conversations List
• customMessagesCreate - Create Custom Message
• customMessagesDelete - Delete Custom Message
• customMessagesGetById - Get Custom Message By Id
• customMessagesList - Custom Messages List
• customMessagesUpdate - Update Custom Message
• dashboardsGetDailyCallVolumeByHour - Get Daily Call Volume By Hour
• dashboardsGetMonthlyCallVolumeByDay - Get Monthly Call Volume By Day
• dashboardsGetMonthlyCallVolumeByWeek - Get Monthly Call Volume By Week
• dashboardsGetSessionAgents - Get Agents
• dashboardsGetSessionSummary - Get Session Summary
• dashboardsGetTotalCallVolumeByHour - Get Total Call Volume By Hour
• dashboardsGetWeeklyCallVolumeByWeekday - Get Weekly Call Volume By Weekday
• dashboardsTotalCallVolumeByWeekday - Get Total Call Volume By Weekday
• directoryCreate - Create Directory Member
• directoryDelete - Delete Directory Member
• directoryGetById - Get Directory Member By Id
• directoryList - Directory Member List
• directoryUpdate - Update Directory Member
• eventsList - Events List
• promptsCreate - Create Prompt
• promptsDelete - Delete Prompt
• promptsGetById - Get Prompt By Id
• promptsList - Prompt List
• promptsPromptsHistory - Get Prompt History
• promptsUpdate - Update Prompt
• servicesCreate - Create Service
• servicesList - Service List
• servicesUpdate - Update Service
• sessionLabelsCreate - Create Label
• sessionLabelsGetById - Get Label By Id
• sessionLabelsList - Session Labels List
• sessionsGenerateSessionRecordingUrls - Generate Recording Urls
• sessionsGetById - Get A Single Session By Id
• sessionsList - Sessions List
• sessionsSessionRecordingStream - Stream Recording
• sessionsTranscriptGetById - Get Session Transcript By Id
• toolsCreate - Create Tool
• toolsGetByName - Tool Info
• toolsList - Tool List
• toolsUpdate - Update Tool
• v1Create - Create Directory Member
• v1Delete - Delete Directory Member
• v1GetById - Get Directory Member By Id
• v1List - Directory Member List
• v1Update - Update Directory Member

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({});

  // Handle the result
  console.log(result);
}

run();

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	*/*

import { SyllableSDK } from "syllable-sdk";
import {
  HTTPValidationError,
  SDKValidationError,
} from "syllable-sdk/models/errors";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  let result;
  try {
    result = await syllableSDK.agents.list({});

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof HTTPValidationError): {
        // Handle err.data$: HTTPValidationErrorData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server
0	http://localhost:8001
1	http://localhost:8001

Example

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  serverIdx: 1,
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({});

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  serverURL: "http://localhost:8001",
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({});

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { SyllableSDK } from "syllable-sdk";
import { HTTPClient } from "syllable-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new SyllableSDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
apiKeyHeader	apiKey	API key	SYLLABLESDK_API_KEY_HEADER

To authenticate with the API the apiKeyHeader parameter must be set when initializing the SDK client instance. For example:

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({});

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { SyllableSDK } from "syllable-sdk";

const sdk = new SyllableSDK({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable SYLLABLESDK_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy