Update Prompt

Update an existing prompt

Request body

namestring required

The prompt name

descriptionstring nullable

The description of the prompt

typestring required

The type of the prompt

contextstring nullable

The prompt text that will be sent to the LLM at the beginning of the conversation

toolsstring[]

Names of tools to which the prompt has access

session_end_enabledboolean

Whether session end functionality is enabled for this prompt

session_end_tool_idinteger nullable

ID of the optional session end tool associated with the prompt

edit_commentsstring nullable

The comments for the most recent edit to the prompt

idinteger required

The internal ID of the prompt

include_default_toolsboolean

Whether to include the default tools (hangup) in the list of tools for the prompt (also includes set_current_language if any of the agents assigned to the prompt have Dynamic Language Switching enabled). If you remove one of the default tools from your prompt, you might want to disable this option so that the tool is not added again when updated.

Example request

{
  "name": "Weather Agent Prompt",
  "description": "Prompt for a weather agent.",
  "type": "prompt_v1",
  "context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
  "tools": [],
  "llm_config": {
    "model": "gpt-4o",
    "version": "2024-05-13",
    "api_version": "2024-06-01",
    "temperature": 1,
    "seed": 123
  },
  "session_end_tool_id": 1,
  "edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
  "id": 1,
  "include_default_tools": true
}

Response

Successful Response