Modify Agent

PATCH

/v1/agents/:agent_id

PATCH

/v1/agents/:agent_id

1 from letta_client import Letta
2 
3 client = Letta(
4     project="YOUR_PROJECT",
5     token="YOUR_TOKEN",
6 )
7 client.agents.modify(
8     agent_id="agent_id",
9 )

Try it

200

1 {
2   "id": "foo",
3   "name": "foo",
4   "system": "foo",
5   "agent_type": "memgpt_agent",
6   "llm_config": {
7     "model": "foo",
8     "model_endpoint_type": "openai",
9     "context_window": 42,
10     "model_endpoint": "foo",
11     "provider_name": "foo",
12     "provider_category": "base",
13     "model_wrapper": "foo",
14     "put_inner_thoughts_in_kwargs": true,
15     "handle": "foo",
16     "temperature": 0.7,
17     "max_tokens": 42,
18     "enable_reasoner": false,
19     "reasoning_effort": "low",
20     "max_reasoning_tokens": 0
21   },
22   "embedding_config": {
23     "embedding_endpoint_type": "openai",
24     "embedding_model": "foo",
25     "embedding_dim": 42,
26     "embedding_endpoint": "foo",
27     "embedding_chunk_size": 42,
28     "handle": "foo",
29     "batch_size": 32,
30     "azure_endpoint": "foo",
31     "azure_version": "foo",
32     "azure_deployment": "foo"
33   },
34   "memory": {
35     "blocks": [
36       {
37         "value": "foo",
38         "limit": 5000,
39         "name": "foo",
40         "is_template": false,
41         "preserve_on_migration": true,
42         "label": "foo",
43         "read_only": false,
44         "description": "foo",
45         "metadata": {},
46         "id": "block-123e4567-e89b-12d3-a456-426614174000",
47         "created_by_id": "foo",
48         "last_updated_by_id": "foo"
49       }
50     ],
51     "file_blocks": [
52       {
53         "value": "foo",
54         "limit": 5000,
55         "name": "foo",
56         "is_template": false,
57         "preserve_on_migration": true,
58         "label": "foo",
59         "read_only": false,
60         "description": "foo",
61         "metadata": {},
62         "id": "block-123e4567-e89b-12d3-a456-426614174000",
63         "created_by_id": "foo",
64         "last_updated_by_id": "foo"
65       }
66     ],
67     "prompt_template": "{% for block in blocks %}<{{ block.label }}>\n<metadata>read_only=\"{{ block.read_only}}\" chars_current=\"{{ block.value|length }}\" chars_limit=\"{{ block.limit }}\"</metadata><value>{{ block.value }}\n</value></{{ block.label }}>\n{% if not loop.last %}\n{% endif %}{% endfor %}"
68   },
69   "tools": [
70     {
71       "id": "tool-123e4567-e89b-12d3-a456-426614174000",
72       "tool_type": "custom",
73       "description": "foo",
74       "source_type": "foo",
75       "name": "foo",
76       "tags": [
77         "foo"
78       ],
79       "source_code": "foo",
80       "json_schema": {},
81       "args_json_schema": {},
82       "return_char_limit": 6000,
83       "pip_requirements": [
84         {
85           "name": "foo",
86           "version": "foo"
87         }
88       ],
89       "created_by_id": "foo",
90       "last_updated_by_id": "foo",
91       "metadata_": {}
92     }
93   ],
94   "sources": [
95     {
96       "name": "foo",
97       "embedding_config": {
98         "embedding_endpoint_type": "openai",
99         "embedding_model": "foo",
100         "embedding_dim": 42,
101         "embedding_endpoint": "foo",
102         "embedding_chunk_size": 42,
103         "handle": "foo",
104         "batch_size": 32,
105         "azure_endpoint": "foo",
106         "azure_version": "foo",
107         "azure_deployment": "foo"
108       },
109       "id": "source-123e4567-e89b-12d3-a456-426614174000",
110       "description": "foo",
111       "instructions": "foo",
112       "metadata": {},
113       "created_by_id": "foo",
114       "last_updated_by_id": "foo",
115       "created_at": "foo",
116       "updated_at": "foo"
117     }
118   ],
119   "tags": [
120     "foo"
121   ],
122   "created_by_id": "foo",
123   "last_updated_by_id": "foo",
124   "created_at": "foo",
125   "updated_at": "foo",
126   "tool_rules": [
127     {
128       "tool_name": "foo",
129       "type": "constrain_child_tools",
130       "prompt_template": "foo",
131       "children": [
132         "foo"
133       ]
134     }
135   ],
136   "message_ids": [
137     "foo"
138   ],
139   "response_format": {
140     "type": "text"
141   },
142   "description": "foo",
143   "metadata": {},
144   "tool_exec_environment_variables": [
145     {
146       "key": "foo",
147       "value": "foo",
148       "agent_id": "foo",
149       "created_by_id": "foo",
150       "last_updated_by_id": "foo",
151       "created_at": "foo",
152       "updated_at": "foo",
153       "id": "agent-env-123e4567-e89b-12d3-a456-426614174000",
154       "description": "foo"
155     }
156   ],
157   "project_id": "foo",
158   "template_id": "foo",
159   "base_template_id": "foo",
160   "identity_ids": [
161     "foo"
162   ],
163   "message_buffer_autoclear": false,
164   "enable_sleeptime": true,
165   "multi_agent_group": {
166     "id": "foo",
167     "manager_type": "round_robin",
168     "agent_ids": [
169       "foo"
170     ],
171     "description": "foo",
172     "shared_block_ids": [
173       "foo"
174     ],
175     "manager_agent_id": "foo",
176     "termination_token": "foo",
177     "max_turns": 42,
178     "sleeptime_agent_frequency": 42,
179     "turns_counter": 42,
180     "last_processed_message_id": "foo",
181     "max_message_buffer_length": 42,
182     "min_message_buffer_length": 42
183   },
184   "last_run_completion": "foo",
185   "last_run_duration_ms": 42,
186   "timezone": "foo"
187 }

Update an existing agent

Path parameters

agent_idstringRequired

Request

This endpoint expects an object.

namestringOptional

The name of the agent.

tool_idslist of stringsOptional

The ids of the tools used by the agent.

source_idslist of stringsOptional

The ids of the sources used by the agent.

block_idslist of stringsOptional

The ids of the blocks used by the agent.

tagslist of stringsOptional

The tags associated with the agent.

systemstringOptional

The system prompt used by the agent.

tool_ruleslist of objectsOptional

The tool rules governing the agent.

llm_configobjectOptional

The LLM configuration used by the agent.

embedding_configobjectOptional

The embedding configuration used by the agent.

message_idslist of stringsOptional

The ids of the messages in the agent’s in-context memory.

descriptionstringOptional

The description of the agent.

metadataobjectOptional

The metadata of the agent.

tool_exec_environment_variablesmap from strings to stringsOptional

The environment variables for tool execution specific to this agent.

project_idstringOptional

The id of the project the agent belongs to.

template_idstringOptional

The id of the template the agent belongs to.

base_template_idstringOptional

The base template id of the agent.

identity_idslist of stringsOptional

The ids of the identities associated with this agent.

message_buffer_autoclearbooleanOptional

If set to True, the agent will not remember previous messages (though the agent will still retain state via core memory blocks and archival/recall memory). Not recommended unless you have an advanced use case.

modelstringOptional

The LLM configuration handle used by the agent, specified in the format provider/model-name, as an alternative to specifying llm_config.

embeddingstringOptional

The embedding configuration handle used by the agent, specified in the format provider/model-name.

enable_sleeptimebooleanOptional

If set to True, memory management will move to a background agent thread.

response_formatobjectOptional

The response format for the agent.

last_run_completionstringOptionalformat: "date-time"

The timestamp when the agent last completed a run.

last_run_duration_msintegerOptional

The duration in milliseconds of the agent's last run.

timezonestringOptional

The timezone of the agent (IANA format).

Response

Successful Response

idstring

The id of the agent. Assigned by the database.

namestring

The name of the agent.

systemstring

The system prompt used by the agent.

agent_typeenum

The type of agent.

llm_configobject

The LLM configuration used by the agent.

embedding_configobject

The embedding configuration used by the agent.

memoryobject

The in-context memory of the agent.

toolslist of objects

The tools used by the agent.

sourceslist of objects

The sources used by the agent.

tagslist of strings

The tags associated with the agent.

created_by_idstring or null

The id of the user that made this object.

last_updated_by_idstring or null

The id of the user that made this object.

created_atstring or nullformat: "date-time"

The timestamp when the object was created.

updated_atstring or nullformat: "date-time"

The timestamp when the object was last updated.

tool_ruleslist of objects or null

The list of tool rules.

message_idslist of strings or null

The ids of the messages in the agent’s in-context memory.

response_formatobject or null

The response format used by the agent when returning from send_message.

descriptionstring or null

The description of the agent.

metadataobject or null

The metadata of the agent.

tool_exec_environment_variableslist of objects or null

The environment variables for tool execution specific to this agent.

project_idstring or null

The id of the project the agent belongs to.

template_idstring or null

The id of the template the agent belongs to.

base_template_idstring or null

The base template id of the agent.

identity_idslist of strings or null

The ids of the identities associated with this agent.

message_buffer_autoclearboolean or nullDefaults to false

enable_sleeptimeboolean or null

If set to True, memory management will move to a background agent thread.

multi_agent_groupobject or null

The multi-agent group that this agent manages

last_run_completionstring or nullformat: "date-time"

The timestamp when the agent last completed a run.

last_run_duration_msinteger or null

The duration in milliseconds of the agent's last run.

timezonestring or null

The timezone of the agent (IANA format).

Path parameters

Headers

Request

Response