Agent Personas

Update agent persona

Changed on

Update one or more fields on a persona.

put/api/v0/agent/personas/{persona_id}

Request

Path parameters

persona_idstring uuid required

Request body

namestring nullable

New name.

descriptionstring nullable

New description.

promptstring nullable

New system prompt.

builtin_tool_idsstring[] nullable
builtin_tool_configsobject nullable

Replace the per-builtin config dict wholesale. None means leave it alone; an empty dict clears all per-builtin config.

knowledge_graph_idstring uuid nullable

New graph for the persona's knowledge-graph tools; null clears it. Omitted, the persona keeps its graph, unless builtin_tool_configs names another or builtin_tool_ids enables no knowledge-graph tool.

custom_tool_idsstring[] nullable
mcp_server_idsstring[] nullable
knowledge_base_idsstring[] nullable
skill_idsstring[] nullable

New full skill list (replaces existing). None means leave the existing associations alone; an empty list means clear them.

Response

Successful Response

idstring uuid required

The ID of the persona.

namestring required

The name of the persona.

descriptionstring required

The description of the persona.

promptstring required

The system prompt for the persona.

builtin_tool_idsstring[]

Built-in tool IDs assigned to this persona.

builtin_tool_configsobject

Per-builtin config keyed by tool id. Only configurable builtins (currently invoke_persona) carry config; the dict is sparse.

knowledge_graph_idstring uuid nullable

The graph-enabled collection the persona's knowledge-graph tools target; null when none is wired, no such tool is enabled, or the collection was deleted.

is_roamingboolean

True iff the persona enables a tool that requires a workspace.

custom_tool_idsstring[]

Custom tool UUIDs assigned to this persona.

knowledge_base_idsstring[]

Knowledge base UUIDs assigned to this persona.

skill_idsstring[]

Skill UUIDs preloaded by this persona: instruction documents the agent can read on demand via the read_skill tool.

mcp_server_idsstring[]

MCP server UUIDs connected to this persona.

created_atstring date-time required

When the persona was created.

updated_atstring date-time required

When the persona was last updated.

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status