Syllable Agents API is one of 41 APIs that Syllable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
7 operations
across 4 paths,
and defines 78 schemas.
It is described by OpenAPI 3.2.0, at version 0.0.3.
Requests are made against a single base URL, https://api.syllable.cloud.
The identity and technical contract details declared by the specification.
LoadToolFromFileTask
object
Bootstraps a tool from a file (for internal developer use only if ENV.local=True).
8 properties
1 required
SayAction
object
4 properties
1 required
ExpressionTaskEvents
object
Actions to perform when events occur (start, submit).
2 properties
ValidationIssue
object
A single validation finding with severity, location, and description.
5 properties
2 required
ExpressionTask
object
11 properties
EventTaskEvents
object
1 property
PromptResponse
object
Response model for prompt operations. A prompt defines the behavior of an agent by delivering instructions to the LLM about how the agent should behave. A prom…
16 properties
5 required
ChannelTargetResponse
object
Response model for channel target operations. A channel target links a channel to an agent, allowing users to communicate with the agent through that channel.…
12 properties
8 required
DaoToolResponse
object
11 properties
7 required
ToolParameterTransform
object
A transform to be applied to the value of a tool parameter. Either value or format must be set: - value is any arbitrary value: string, list or dictionary. - f…
4 properties
AgentResponse
object
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,…
27 properties
9 required
AgentUpdate
object
Request model to update an existing agent.
20 properties
7 required
LanguageCode
string
BCP 47 codes of languages that Syllable supports.
ConditionalValue
object
3 properties
ToolDefinition
object
A tool that can be called from an LLM during the conversation. See https://docs.syllable.ai/Resources/Tools.
8 properties
1 required
ToolHttpMethod
string
The HTTP method to use for a tool HTTP request.
StaticToolParameter
object
A parameter for the tool whose value should be set at config time.
5 properties
3 required
ToolParameterTransformCondition
object
A condition to be met for a transform to be applied to the value of a tool parameter.
3 properties
2 required
ToolHttpEndpoint
object
The configuration for an HTTP API call by a tool.
4 properties
3 required
NextStep
object
Represents a conditional transition to the next step.
3 properties
1 required
SaveAction
object
4 properties
LanguageGroupResponse
object
Response model for voice group operations. A voice group is a collection of language, voice, and DTMF configuration that can be linked to an agent to define th…
9 properties
6 required
TtsProvider
string
TTS provider for an agent voice.
HTTPValidationError
object
1 property
EventTask
object
8 properties
ContextTaskMetadata
object
1 property
ToolParameterDefault
object
The default value for a parameter of a tool call.
1 property
1 required
ToolAgentInfo
object
Information about an agent linked to a tool via a prompt.
2 properties
2 required
StepEventActions
object
Actions to perform when events occur (enter, presubmit, submit).
4 properties
PromptLlmProvider
string
LLM API provider.
CustomMessageResponse
object
Response model for custom message operations. A custom message is a pre-configured message delivered by an agent (e.g. as a greeting at the beginning of a conv…
12 properties
6 required
AgentVoice
object
Voice option for an agent.
7 properties
7 required
AgentVoiceModel
string
Model for an agent voice.
LanguageConfig
object
Voice and DTMF configurations for a language in a language group. List of available voices and their supported languages can be fetched from GET /agents/voices…
6 properties
4 required
CallResultSaveMapping
object
One field-extraction mapping applied to a call action's tool response. Example: {"from": "isvalid", "to": "isvalid"} Example (derived value): {"from": "status…
2 properties
2 required
Step
object
7 properties
2 required
PromptLlmConfig
object
LLM configuration for a prompt.
6 properties
AgentVoiceDisplayName
string
Display names of voices that Syllable supports.
ToolPromptInfo
object
Information about a prompt linked to a tool.
2 properties
2 required
ContextToolInfo
object
2 properties
StepsTask
object
9 properties
ToolOptions
object
The options for a tool call.
1 property
ValidationError
object
3 properties
3 required
ToolArgumentLocation
string
The location of the argument in a tool HTTP request. 'body' is used for JSON data in the POST request body. 'form' is used for form data in the POST request bo…
CallAction
object
5 properties
1 required
AgentSttProvider
string
Speech-to-text providers supported by agents.
InternalTool
object
A tool definition to be used by the OpenAI API.
2 properties
1 required
ToolResponse
object
Response model for tool operations. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing da…
12 properties
7 required
ConditionalText
object
2 properties
1 required
AgentToolFieldDefault
object
Agent-level value for a static parameter on a tool, overriding the tool-level default if one exists.
2 properties
2 required
ToolFunction
object
A function available to an agent. See: - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling
3 properties
3 required
CustomMessageRule
object
A rule used to determine whether a custom message should present a variant message based on the current timestamp.
7 properties
3 required
GetValueAction
object
6 properties
DayOfWeek
string
Available options for day of the week for use in message rules.
CallResult
object
Deterministic result-capture configuration for a call action's tool response.
1 property
CelExpression
object
Google CEL expression object. Use this object form when you want CEL syntax: {"type": "cel", "expression": "inputs.count + 1"} See https://github.com/google/ce…
2 properties
1 required
AgentVoiceVarName
string
The variable name of an agent voice (used when processing messages).
JMESPathExpression
object
JMESPath expression object. Use this object form to explicitly mark JMESPath syntax: {"type": "jp", "expression": "inputs.cansignconsent == true"} See https://…
2 properties
1 required
InputParameter
object
9 properties
1 required
AgentToolDefaults
object
Agent-level static parameter values for a tool, overriding any tool-level defaults.
2 properties
2 required
Variable
object
10 properties
1 required
IncrementAction
object
4 properties
1 required
LanguageGroupAgentInfo
object
Information about an agent linked to a language group.
2 properties
2 required
AgentLanguage
object
Language option for an agent.
2 properties
2 required
AgentWaitSound
string
Wait sounds supported by agents.
Context
object
1 property
AgentProperties
string
Names of agent fields supported for filtering/sorting on list endpoint.
StaticToolParameterType
string
The expected type for a static tool parameter.
ListResponse_AgentResponse_
object
5 properties
3 required
AgentCreate
object
Request model to create an agent.
19 properties
6 required
CustomMessageType
string
Type of custom message. Greeting is for voice; emailtemplate is for email (subject + body).
StepTools
object
Configuration for tools available in a step.
3 properties
OrderByDirection
string
The direction in which to order list results, either ascending or descending.
SetValueAction
object
5 properties
1 required
AgentVoiceGender
string
Gender for an agent voice.
TargetModes
string
Available modes (communication methods) for channel targets.
CaseExpression
object
Conditional branch expression. Note: CaseExpression is currently reserved and not yet executed at runtime.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Syllable publishes across the network.
