Update AI agent
Updates how an existing custom AI Agent behaves in conversations. Use it for an agent configured directly in your SignalWire project; update a linked Dialogflow resource with Update Dialogflow agent.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.
Authentication
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)
Path parameters
Request
Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately.
An array of JSON objects defining supported languages in the conversation.
Mutually exclusive with multilingual: if both are set, multilingual is used and
this array is ignored.
A JSON object containing parameters as key-value pairs.
The final set of instructions and configuration settings to send to the agent.
An array of JSON objects to clarify the AI's pronunciation of words or expressions.
Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations. The prompt establishes how the agent should interact with callers, what information it should gather, and how it should respond to various scenarios. It is recommended to write prompts using markdown formatting.
An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.