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:
Syllble SDK gives you the power of awesome AI agentry. 🚀
The Syllble 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, Syllble 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.
agentsCreate - 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 MessagedashboardsGetDailyCallVolumeByHour - Get Daily Call Volume By HourdashboardsGetMonthlyCallVolumeByDay - Get Monthly Call Volume By DaydashboardsGetMonthlyCallVolumeByWeek - Get Monthly Call Volume By WeekdashboardsGetSessionAgents - Get AgentsdashboardsGetSessionSummary - Get Session SummarydashboardsGetTotalCallVolumeByHour - Get Total Call Volume By HourdashboardsGetWeeklyCallVolumeByWeekday - Get Weekly Call Volume By WeekdaydashboardsTotalCallVolumeByWeekday - Get Total Call Volume By WeekdayeventsList - Events ListpromptsCreate - Create PromptpromptsDelete - Delete PromptpromptsGetById - Get Prompt By IdpromptsList - Prompt ListpromptsPromptsHistory - Get Prompt HistorypromptsUpdate - Update PromptservicesCreate - Create ServiceservicesList - Service ListservicesUpdate - Update ServicesessionLabelsCreate - Create LabelsessionLabelsGetById - Get Label By IdsessionLabelsList - Session Labels ListsessionsGenerateSessionRecordingUrls - Generate Recording UrlssessionsGetById - Get A Single Session By IdsessionsList - Sessions ListsessionsSessionRecordingStream - Stream RecordingsessionsTranscriptGetById - Get Session Transcript By IdtoolsCreate - Create TooltoolsGetByName - Tool InfotoolsList - Tool ListtoolsUpdate - Update ToolSome 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();
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.
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 |
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();
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();
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
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.