syllable-sdk
Advanced tools
Developer-friendly & type-safe TypeScript SDK specifically catered to leverage *syllable-sdk* API.
Developer-friendly & type-safe TypeScript SDK specifically catered to leverage syllable-sdk API.
SyllableSDK:
Syllable SDK gives you the power of awesome AI agentry. 🚀
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.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add syllable-sdk
pnpm add syllable-sdk
bun add syllable-sdk
yarn add syllable-sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
For supported JavaScript runtimes, please consult RUNTIMES.md.
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();
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.
agentsAgentGetAvailableVoices - Get Available Agent VoicesagentsCreate - Create AgentagentsDelete - Delete AgentagentsGetById - Get Agent By IdagentsList - Agent ListagentsTestSendTestMessage - Send New MessageagentsUpdate - Update AgentchannelsDelete - Delete Channel TargetchannelsList - Get ChannelschannelsTargetsAvailableTargets - Available Targets ListchannelsTargetsCreate - Assign A Channel TargetchannelsTargetsGetById - Get A Channel TargetchannelsTargetsList - Get Channel TargetschannelsTargetsUpdate - Edit Channel TargetconversationsList - Conversations ListcustomMessagesCreate - Create Custom MessagecustomMessagesDelete - Delete Custom MessagecustomMessagesGetById - Get Custom Message By IdcustomMessagesList - Custom Messages ListcustomMessagesUpdate - Update Custom MessagedashboardsPostGetDashboard - Post Fetch InfodashboardsPostListDashboard - Post List DashboardsdataSourcesCreate - Create Data SourcedataSourcesDelete - Delete Data SourcedataSourcesGetById - Get Data SourcedataSourcesList - List Data SourcesdataSourcesUpdate - Update Data SourceeventsList - Events ListinsightsToolsCreate - Create Insight ToolinsightsToolsGetById - Get Insight Tool By IdinsightsToolsInsightToolGetDefinitions - Get Insight Tool DefinitionsinsightsToolsList - Insight Tool ListinsightsToolsUpdate - Update Insights ToolinsightsWorkflowsCreate - Create Insight WorkflowinsightsWorkflowsDelete - Delete Insights WorkflowinsightsWorkflowsGetById - Get Insight Workflow By IdinsightsWorkflowsList - Insight Workflow ListinsightsWorkflowsUpdate - Update Insights WorkflowlanguageGroupsCreate - Create Language GrouplanguageGroupsDelete - Delete Language GrouplanguageGroupsGetById - Get Language GrouplanguageGroupsList - List Language GroupslanguageGroupsUpdate - Update Language GrouppromptsCreate - Create PromptpromptsDelete - Delete PromptpromptsGetById - Get Prompt By IdpromptsList - Prompt ListpromptsPromptsHistory - Get Prompt HistorypromptsUpdate - Update PromptservicesCreate - Create ServiceservicesDelete - Delete ServiceservicesGetById - Get Service By IdservicesList - Service ListservicesUpdate - Update ServicesessionLabelsCreate - Create LabelsessionLabelsGetById - Get Label By IdsessionLabelsList - Session Labels ListsessionsFullSummaryGetById - Get Full Session Summary By IdsessionsGenerateSessionRecordingUrls - Generate Recording UrlssessionsGetById - Get A Single Session By IdsessionsList - Sessions ListsessionsSessionRecordingStream - Stream RecordingsessionsSummaryGetById - Get Session Summary By IdsessionsTranscriptGetById - Get Session Transcript By IdtoolsCreate - Create TooltoolsDelete - Delete TooltoolsGetByName - Tool InfotoolsList - Tool ListtoolsUpdate - Update Toolv1PostGetDashboard - Post Fetch Infov1PostListDashboard - Post List DashboardsdashboardsPostSessionEventsDashboarddashboardsPostSessionsDashboarddashboardsPostSessionSummaryDashboarddashboardsPostSessionTransfersDashboardv1PostSessionEventsDashboardv1PostSessionsDashboardv1PostSessionSummaryDashboardv1PostSessionTransfersDashboardSome 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();
Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. 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 | */* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.
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) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Pretty-print will provide a human-readable multi-line error message
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: {
// Other errors such as network errors, see HTTPClientErrors for more details
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 multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in 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 |
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: "https://api.syllable.cloud",
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.agents.list({});
// Handle the result
console.log(result);
}
run();
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 });
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();
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.
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.
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.
FAQs
Developer-friendly & type-safe TypeScript SDK specifically catered to leverage *syllable-sdk* API.
We found that syllable-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.