SDK Overview

Use the Syllable SDK to call the Syllable API from TypeScript or Python. This quickstart installs the client, configures an API token, and lists the agents available to your organization.

1. Install the SDK

TypeScript

npm install syllable-sdk

Python

pip install syllable-sdk

For additional package-manager options, see SDK environment setup.

2. Get an API token

Create a token in the Syllable Console and copy it when it is displayed. See Create and manage API tokens for the complete procedure, token limits, rotation guidance, and security practices.

Store the token in an environment variable rather than in application source:

export SYLLABLE_API_KEY="your-api-token"

3. Configure the client and make a request

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllable = new SyllableSDK({
  apiKeyHeader: process.env.SYLLABLE_API_KEY ?? "",
});

const result = await syllable.agents.list({ page: 0, limit: 25 });
console.log(result);

Python

import os
from syllable_sdk import SyllableSDK

with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as syllable:
    result = syllable.agents.list(page=0, limit=25)
    print(result)

The request uses your API token to access the selected organization. See Agent List for all parameters and response fields, or follow Build your first agent for a guided workflow.