Skip to main content
POST
Typescript (SDK)

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Request model to create an agent.

name
string
required

The agent name

Example:

"Weather agent"

type
string
required

The agent type. Must be "ca_v1" currently.

Example:

"ca_v1"

prompt_id
integer
required

ID of the prompt associated with the agent

Example:

1

timezone
string
required

The time zone in which the agent operates

Examples:

"America/New_York"

"America/Chicago"

variables
Variables · object
required

Custom context variables for the conversation session. Keys should be prefixed with "vars.".

Example:
tool_headers
Tool Headers · object | null
required

Optional headers to include in tool calls for agent. (It is discouraged to use this field for "Authorization" headers, as values here are not encrypted. Instead, set up a service with either basic, bearer, or custom header auth; attach the appropriate tools to that service, and the attached tools will automatically use the auth configured on the service.)

Example:
description
string | null

The agent description

Example:

"Agent for answering questions about weather."

label
string | null
deprecated

The agent label (DEPRECATED - use labels instead.)

Example:

"Information"

labels
string[] | null

The agent labels

Example:
custom_message_id
integer | null

Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent

Example:

1

language_group_id
integer | null

Internal ID of the language group associated with the agent

Example:

1

bridge_phrases_id
integer | null

Internal ID of the bridge phrases config associated with the agent

Example:

1

prompt_tool_defaults
AgentToolDefaults · object[]

Agent-level static parameter values for the agent's tools, overriding any tool-level defaults

Example:
languages
string[]
deprecated

BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)

Example:
agent_initiated
boolean
default:false

Whether the agent initiates conversation with a user after the custom message is delivered

Example:

false

stt_provider
enum<string> | null

Speech-to-text provider for the agent.

Available options:
Google STT V2 (Chirp 2),
Deepgram Nova 3 (On-Prem),
Deepgram Nova 3,
Google STT V2,
Google STT V1,
Deepgram Nova 2
Example:

"Google STT V2 (Chirp 2)"

wait_sound
enum<string> | null

Sound to play while waiting for a response from the LLM.

Available options:
No Sound,
Keyboard 1,
Keyboard 2,
Call Center
Example:

"No Sound"

enable_verbal_language_change
boolean
default:false

Enables Dynamic Language Switching - when true and a voice group is configured, callers may switch among group languages by speaking at any point in the conversation (in addition to DTMF in response to the language menu).

Example:

false

Response

Successful Response

Response model for agent operations. When a user interacts with the Syllable system, they do so by communicating with an agent. An agent is linked to a prompt, a custom message, and one or more channel targets to define its behavior and capabilities. For more information, see Console docs.

name
string
required

The agent name

Example:

"Weather agent"

type
string
required

The agent type. Must be "ca_v1" currently.

Example:

"ca_v1"

prompt_id
integer
required

ID of the prompt associated with the agent

Example:

1

timezone
string
required

The time zone in which the agent operates

Examples:

"America/New_York"

"America/Chicago"

variables
Variables · object
required

Custom context variables for the conversation session. Keys should be prefixed with "vars.".

Example:
tool_headers
Tool Headers · object | null
required

Optional headers to include in tool calls for agent. (It is discouraged to use this field for "Authorization" headers, as values here are not encrypted. Instead, set up a service with either basic, bearer, or custom header auth; attach the appropriate tools to that service, and the attached tools will automatically use the auth configured on the service.)

Example:
id
integer
required

Internal ID of the agent

Example:

1

updated_at
string<date-time>
required

Timestamp of most recent update

Example:

"2024-01-01T00:00:00Z"

last_updated_by
string | null
required

Email of the user who last updated the agent

Example:

"user@email.com"

description
string | null

The agent description

Example:

"Agent for answering questions about weather."

label
string | null
deprecated

The agent label (DEPRECATED - use labels instead.)

Example:

"Information"

labels
string[] | null

The agent labels

Example:
custom_message_id
integer | null

Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent

Example:

1

language_group_id
integer | null

Internal ID of the language group associated with the agent

Example:

1

bridge_phrases_id
integer | null

Internal ID of the bridge phrases config associated with the agent

Example:

1

prompt_tool_defaults
AgentToolDefaults · object[]

Agent-level static parameter values for the agent's tools, overriding any tool-level defaults

Example:
languages
string[]
deprecated

BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)

Example:
agent_initiated
boolean
default:false

Whether the agent initiates conversation with a user after the custom_message is delivered

Example:

false

stt_provider
string | null

Speech-to-text provider for the agent.

Example:

"Google STT V2 (Chirp 2)"

wait_sound
string | null

Sound to play while waiting for a response from the LLM.

Example:

"No Sound"

enable_verbal_language_change
boolean
default:false

Enables Dynamic Language Switching - when true and a voice group is configured, callers may switch among group languages by speaking at any point in the conversation (in addition to DTMF in response to the language menu).

Example:

false

prompt
PromptResponse · object | null

The prompt associated with the agent.

custom_message
CustomMessageResponse · object | null

The message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.

channel_targets
ChannelTargetResponse · object[] | null

Channel targets associated with the agent

tools
ToolResponse · object[] | null

Tools associated with the agent

language_group
LanguageGroupResponse · object | null

The language group associated with the agent