Components
AgentResponse
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.
Example Usage
Fields
Field | Type | Required | Description | Example |
---|---|---|---|---|
name | string | TRUE | The agent name | |
description | string | FALSE | The agent description | |
label | string | FALSE | The agent label | |
type | string | TRUE | The agent type. Can be an arbitrary string | ca_v1 |
promptId | number | TRUE | ID of the prompt associated with the agent | |
customMessageId | number | TRUE | ID of the custom message that should be delivered at the beginning of a conversation with the agent | |
timezone | string | TRUE | The time zone in which the agent operates | America/New_York |
promptToolDefaults | components.AgentToolDefaults[] | FALSE | User-configured parameter values for the agent’s tools | |
languages | string[] | FALSE | BCP 47 codes of languages the agent supports | [ “en-US”, “es-US” ] |
variables | Record | TRUE | Custom context variables for the conversation session. Keys should be prefixed with “vars.”. | |
toolHeaders | Record | TRUE | Optional headers to include in tool calls for agent. | |
agentInitiated | boolean | FALSE | Whether the agent initiates conversation with a user after the custom_message is delivered | |
id | number | TRUE | The agent ID | |
updatedAt | Date | TRUE | Timestamp of most recent update | |
lastUpdatedBy | string | TRUE | Email of the user who last updated the agent | |
prompt | components.PromptResponse | FALSE | The prompt associated with the agent. | |
customMessage | components.CustomMessageResponse | FALSE | The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation. | |
channelTargets | components.ChannelTargetResponse[] | FALSE | Channel targets associated with the agent | |
tools | components.ToolResponse[] | FALSE | Tools associated with the agent |