Update Prompt

The UpdatePrompt message is a JSON message that you can use to update the system prompt of the agent.

Purpose

The UpdatePrompt message is a JSON message that allows you to update the system prompt of the agent. UpdatePrompt will add to – not replace – the current prompt. This flexibility enables real-time adjustments to the agent’s behavior, ensuring a more dynamic and responsive interaction tailored to the evolving needs of the conversation.

Prompt length is limited to 25,000 characters for managed LLMs and unlimited for BYO LLMs.

Example Payloads

To send the UpdatePrompt message, you need to send the following JSON message to the server:

1
{
2
  "type": "UpdatePrompt",
3
  "prompt": "" // The new system prompt
4
}

Upon receiving the UpdatePrompt message, the server will process all remaining audio data and return a PromptUpdated message.

1
{
2
    "type": "PromptUpdated"
3
}