Skip to content

asksyllable/syllable-sdk-typescript

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,562 Commits
.devcontainer
.devcontainer
 
 
.github/workflows
.github/workflows
 
 
.speakeasy
.speakeasy
 
 
api-reference
api-reference
 
 
docs
docs
 
 
examples
examples
 
 
sdk-docs
sdk-docs
 
 
src
src
 
 
test/sdk/contract
test/sdk/contract
 
 
tools
tools
 
 
.DS_Store
.DS_Store
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
.npmignore
.npmignore
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
FUNCTIONS.md
FUNCTIONS.md
 
 
README.md
README.md
 
 
RELEASES.md
RELEASES.md
 
 
RUNTIMES.md
RUNTIMES.md
 
 
USAGE.md
USAGE.md
 
 
codeSamples.yaml
codeSamples.yaml
 
 
eslint.config.mjs
eslint.config.mjs
 
 
home.mdx
home.mdx
 
 
jsr.json
jsr.json
 
 
openapi-final.json
openapi-final.json
 
 
openapi.json
openapi.json
 
 
openapi.yaml
openapi.yaml
 
 
overlay-remove-V1.yaml
overlay-remove-V1.yaml
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 
tsconfig.tsbuildinfo
tsconfig.tsbuildinfo
 
 

Repository files navigation

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 phone agents, chatbots, virtual assistants, or any other AI-driven solutions, Syllable SDK has got you covered.

Features

  • Agent Configuration: Create and manage agents that can interact with users across various channels.
  • Channel Management: Configure channels like SMS, web chat, and more to connect agents with users.
  • Custom Messages: Set up custom messages that agents can deliver as greetings or responses.
  • Conversations: Track and manage conversations between users and agents, including session management.
  • Tools and Workflows: Leverage tools and workflows to enhance agent capabilities, such as data processing and API calls.
  • Data Sources: Integrate data sources to provide agents with additional context and information.
  • Insights and Analytics: Analyze conversations and sessions to gain insights into user interactions.
  • Permissions and Security: Manage permissions to control access to various features and functionalities.
  • Language Support: Define language groups to enable multilingual support for agents.
  • Outbound Campaigns: Create and manage outbound communication campaigns to reach users effectively.
  • Session Labels: Label sessions with evaluations of quality and descriptions of issues encountered.
  • Incident Management: Track and manage incidents related to agent interactions.

Table of Contents

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

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "SyllableSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "syllable-sdk",
        "--",
        "mcp", "start",
        "--api-key-header", "..."
      ]
    }
  }
}
Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "SyllableSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "syllable-sdk",
        "--",
        "mcp", "start",
        "--api-key-header", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package syllable-sdk -- mcp start --help

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({
    page: 0,
    searchFields: [
      "name",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Agents

Agents.Test

Channels

Channels.Targets

Channels.Twilio

  • getById - Get Twilio Channel By Id
  • update - Update Twilio Channel ⚠️ Deprecated
  • create - Create Twilio Channel ⚠️ Deprecated
Channels.Twilio.Numbers
  • add - Add Twilio Number
  • update - Update Twilio Number
  • list - List Twilio Phone Numbers

ConversationConfig

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

DataSources

Directory

Events

  • list - Events List

Incidents

Insights

  • list - Insights List

Insights.Folders

  • list - List Insights Upload Folders
  • create - Create Insights Upload Folder
  • getById - Get Insights Folder Details
  • delete - Delete Insights Folder
  • update - Update Insights Folder
  • uploadFile - Upload Insights Upload Folder
  • listFiles - Fetch Insights Upload Files
  • moveFiles - Move Insights Upload Files

Insights.Tools

Insights.Workflows

  • list - Insight Workflow List
  • create - Create Insight Workflow
  • getById - Get Insight Workflow By Id
  • update - Update Insights Workflow
  • delete - Delete Insights Workflow
  • inactivate - Inactivate Insights Workflow
  • activate - Activate Insights Workflow
  • queueWork - Queue Insights Workflow For Sessions/Files

LanguageGroups

  • list - List Language Groups ⚠️ Deprecated
  • create - Create Language Group ⚠️ Deprecated
  • update - Update Language Group ⚠️ Deprecated
  • getById - Get Language Group ⚠️ Deprecated
  • delete - Delete Language Group ⚠️ Deprecated
  • languageGroupsCreateVoiceSample - Create Voice Sample ⚠️ Deprecated

Organizations

Outbound.Batches

  • list - List Outbound Communication Batches
  • create - Create Outbound Communication Batch
  • getById - Get Outbound Communication Batch
  • update - Update Outbound Communication Batch
  • delete - Delete Outbound Communication Batch
  • upload - Upload Outbound Communication Batch
  • results - Fetch Outbound Communication Batch Results
  • add - Create Outbound Communication Request
  • remove - Delete Requests By List Of Reference Ids

Outbound.Campaigns

  • list - List Outbound Communication Campaigns
  • create - Create Outbound Communication Campaign
  • getById - Get Outbound Communication Campaign
  • update - Update Outbound Communication Campaign
  • delete - Delete Outbound Communication Campaign

Permissions

  • list - List Permissions

Prompts

Pronunciations

Roles

Services

SessionDebug

SessionLabels

Sessions

Sessions.FullSummary

  • getById - Get Full Session Summary By Id

Sessions.Latency

  • getById - Inspect Latency For Session

Sessions.Transcript

  • getById - Get Session Transcript By Id

Takeouts

Tools

Users

V1

VoiceGroups

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

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { SyllableSDK } from "syllable-sdk";

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

async function run() {
  const result = await syllableSDK.insights.folders.uploadFile({
    folderId: 444923,
    callId: "<id>",
  });

  console.log(result);
}

run();

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({
    page: 0,
    searchFields: [
      "name",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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({
    page: 0,
    searchFields: [
      "name",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  });

  console.log(result);
}

run();

Error Handling

SyllableSDKError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { SyllableSDK } from "syllable-sdk";
import * as errors from "syllable-sdk/models/errors";

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

async function run() {
  try {
    const result = await syllableSDK.agents.list({
      page: 0,
      searchFields: [
        "name",
      ],
      searchFieldValues: [
        "Some Object Name",
      ],
      startDatetime: "2023-01-01T00:00:00Z",
      endDatetime: "2024-01-01T00:00:00Z",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SyllableSDKError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.HTTPValidationError) {
        console.log(error.data$.detail); // ValidationError[]
      }
    }
  }
}

run();

Error Classes

Primary errors:

Less common errors (6)

Network errors:

Inherit from SyllableSDKError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can 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: "https://api.syllable.cloud",
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.agents.list({
    page: 0,
    searchFields: [
      "name",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  });

  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:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { SyllableSDK } from "syllable-sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "syllable-sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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: 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({
    page: 0,
    searchFields: [
      "name",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  });

  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

About

Syllable TypeScript SDK

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

11 watching

Forks

0 forks
Report repository

Releases 275

typescript - v1.0.25 - 2026-02-19 23:42:06 Latest
Feb 19, 2026
+ 274 releases

Contributors 11

Languages