API Reference

Syllable SDK

Home

SDK Reference

Console

Community

Channels

How Syllable works

Key Features

Login and signup

Quick Start Guide

Create a prompt

Create a custom message

Create a channel

Create an Agent

Agents

Session Configuration

Sessions List

Session Details

Prompts

Tools

Custom Messages

Overview

Standalone Functions

Runtimes

Agents define how AI interacts with users

Prompts are the instructions given to the AI agent

Custom messages are used for fixed messages like greetings and introductions

Custom Message

Tools are external services that the Agent can access in order to do work

Services are the configuration of the where tools are deployed

Services

Channels are the ways in which an agent communicates with a user

Targets are the phone-numbers or addresses that the user calls or messages when interacting with an agent

Targets

Directory service is used to provide a phone book when the agent is acting as an operator

Sessions

Conversions are one or more sessions when a user calls back or messages through multiple channels.

Conversations

Transcripts are audits of the conversation between user and agent.

Transcripts

When agents achieve a desired goal, like successfully transferring a user to a destination, the event is tracked here.

Events

Session labels are used to audit and score interactions with users.

Session Labels

Agent

AgentCreate

AgentProperties

AgentResponse

AgentToolDefaults

AgentToolFieldDefault

AgentUpdate

AgentVoice

AgentVoiceVarName

Attributes

AvailableTarget

AvailableTargetProperties

BodyDirectoryMemberBulkLoad

Channel

ChannelProperties

ChannelServices

ChannelTarget

ChannelTargetCreateRequest

ChannelTargetProperties

ChannelTargetUpdateRequest

ContactTags

Conversation

ConversationProperties

CustomMessage

CustomMessageCreateRequest

CustomMessageProperties

CustomMessageResponse

CustomMessageUpdateRequest

DaoChannelTargetAgent

DaoCustomMessageRule

DayOfWeek

Definition

DirectoryExtension

DirectoryMember

DirectoryMemberCreate

DirectoryMemberCreateContactTags

DirectoryMemberProperties

Event

EventProperties

FileT

ListResponseAgentResponse

ListResponseAvailableTarget

ListResponseChannel

ListResponseChannelTarget

ListResponseConversation

ListResponseCustomMessageResponse

ListResponseDirectoryMember

ListResponseEvent

ListResponsePrompt

ListResponseService

ListResponseSession

ListResponseSessionLabel

ListResponseTool

LlmConfig

Numbers

OrderByDirection

Prompt

PromptCreate

PromptHistory

PromptProperties

PromptUpdate

Provider

Response

Security

Service

ServiceCreate

ServiceProperties

ServiceUpdate

Session

SessionAction

SessionLabel

SessionLabelCreate

SessionLabelProperties

SessionProperties

SessionRecordingResponse

SessionText

SessionTranscriptionResponse

SttProvider

Target

TargetModes

TestMessage

TestMessageResponse

Tool

ToolCreate

ToolCreateDefinition

ToolDetailResponse

ToolProperties

ToolUpdate

ToolUpdateDefinition

AgentDeleteRequest

AgentGetByIdRequest

AgentListRequest

AvailableTargetsRequest

ChannelsListRequest

ChannelTargetsCreateRequest

ChannelTargetsDeleteRequest

ChannelTargetsGetByIdRequest

ChannelTargetsListRequest

ChannelTargetsUpdateRequest

ConversationsListRequest

CustomMessageGetByIdRequest

CustomMessagesDeleteRequest

CustomMessagesListRequest

DirectoryMemberDeleteRequest

DirectoryMemberGetByIdRequest

DirectoryMemberListRequest

DirectoryMemberUpdateRequest

EventsListRequest

GenerateSessionRecordingUrlsRequest

PromptsDeleteRequest

PromptsGetByIdRequest

PromptsHistoryRequest

PromptsListRequest

ServiceListRequest

SessionGetByIdRequest

SessionLabelGetByIdRequest

SessionLabelsListRequest

SessionRecordingStreamRequest

SessionsListRequest

SessionTranscriptGetByIdRequest

ToolGetByNameRequest

ToolListRequest

HTTPValidationError

ValidationError

Agent List

Update Agent

Create Agent

Get Agent By Id

Delete Agent

Get Available Agent Voices

Get Channels

Delete Channel Target

Send New Message

Conversations List

Events List

Custom Messages List

Update Custom Message

Create Custom Message

Get Custom Message By Id

Delete Custom Message

Prompt List

Update Prompt

Create Prompt

Get Prompt By Id

Delete Prompt

Get Prompt History

Service List

Update Service

Create Service

Get Label By Id

Session Labels List

Create Label

Get A Single Session By Id

Generate Recording Urls

Introduction to Syllable

Build your first Agent

Workspaces

Resources

Channels