Import Agent Serialized

1 from letta_client import Letta 2 3 client = Letta( 4 token="YOUR_TOKEN", 5 ) 6 client.agents.import_file()

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 "azure_endpoint": "foo", 30 "azure_version": "foo", 31 "azure_deployment": "foo" 32 }, 33 "memory": { 34 "blocks": [ 35 { 36 "value": "foo", 37 "limit": 5000, 38 "name": "foo", 39 "is_template": false, 40 "preserve_on_migration": true, 41 "label": "foo", 42 "read_only": false, 43 "description": "foo", 44 "metadata": {}, 45 "id": "block-123e4567-e89b-12d3-a456-426614174000", 46 "created_by_id": "foo", 47 "last_updated_by_id": "foo" 48 } 49 ], 50 "file_blocks": [ 51 { 52 "value": "foo", 53 "limit": 5000, 54 "name": "foo", 55 "is_template": false, 56 "preserve_on_migration": true, 57 "label": "foo", 58 "read_only": false, 59 "description": "foo", 60 "metadata": {}, 61 "id": "block-123e4567-e89b-12d3-a456-426614174000", 62 "created_by_id": "foo", 63 "last_updated_by_id": "foo" 64 } 65 ], 66 "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 %}" 67 }, 68 "tools": [ 69 { 70 "id": "tool-123e4567-e89b-12d3-a456-426614174000", 71 "tool_type": "custom", 72 "description": "foo", 73 "source_type": "foo", 74 "name": "foo", 75 "tags": [ 76 "foo" 77 ], 78 "source_code": "foo", 79 "json_schema": {}, 80 "args_json_schema": {}, 81 "return_char_limit": 6000, 82 "created_by_id": "foo", 83 "last_updated_by_id": "foo", 84 "metadata_": {} 85 } 86 ], 87 "sources": [ 88 { 89 "name": "foo", 90 "embedding_config": { 91 "embedding_endpoint_type": "openai", 92 "embedding_model": "foo", 93 "embedding_dim": 42, 94 "embedding_endpoint": "foo", 95 "embedding_chunk_size": 42, 96 "handle": "foo", 97 "azure_endpoint": "foo", 98 "azure_version": "foo", 99 "azure_deployment": "foo" 100 }, 101 "id": "source-123e4567-e89b-12d3-a456-426614174000", 102 "description": "foo", 103 "instructions": "foo", 104 "metadata": {}, 105 "created_by_id": "foo", 106 "last_updated_by_id": "foo", 107 "created_at": "foo", 108 "updated_at": "foo" 109 } 110 ], 111 "tags": [ 112 "foo" 113 ], 114 "created_by_id": "foo", 115 "last_updated_by_id": "foo", 116 "created_at": "foo", 117 "updated_at": "foo", 118 "tool_rules": [ 119 { 120 "tool_name": "foo", 121 "type": "constrain_child_tools", 122 "children": [ 123 "foo" 124 ] 125 } 126 ], 127 "message_ids": [ 128 "foo" 129 ], 130 "response_format": { 131 "type": "text" 132 }, 133 "description": "foo", 134 "metadata": {}, 135 "tool_exec_environment_variables": [ 136 { 137 "key": "foo", 138 "value": "foo", 139 "agent_id": "foo", 140 "created_by_id": "foo", 141 "last_updated_by_id": "foo", 142 "created_at": "foo", 143 "updated_at": "foo", 144 "id": "agent-env-123e4567-e89b-12d3-a456-426614174000", 145 "description": "foo" 146 } 147 ], 148 "project_id": "foo", 149 "template_id": "foo", 150 "base_template_id": "foo", 151 "identity_ids": [ 152 "foo" 153 ], 154 "message_buffer_autoclear": false, 155 "enable_sleeptime": true, 156 "multi_agent_group": { 157 "id": "foo", 158 "manager_type": "round_robin", 159 "agent_ids": [ 160 "foo" 161 ], 162 "description": "foo", 163 "shared_block_ids": [ 164 "foo" 165 ], 166 "manager_agent_id": "foo", 167 "termination_token": "foo", 168 "max_turns": 42, 169 "sleeptime_agent_frequency": 42, 170 "turns_counter": 42, 171 "last_processed_message_id": "foo", 172 "max_message_buffer_length": 42, 173 "min_message_buffer_length": 42 174 } 175 }

Import a serialized agent file and recreate the agent in the system.

Query parameters

append_copy_suffixbooleanOptionalDefaults to true

If set to True, appends “_copy” to the end of the agent name.

override_existing_toolsbooleanOptionalDefaults to true

If set to True, existing tools can get their source code overwritten by the uploaded tool definitions. Note that Letta core tools can never be updated externally.

project_idstringOptional

The project ID to associate the uploaded agent with.

strip_messagesbooleanOptionalDefaults to false

If set to True, strips all messages from the agent before importing.

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_idstringOptional

The id of the user that made this object.

last_updated_by_idstringOptional

The id of the user that made this object.

created_atstringOptionalformat: "date-time"

The timestamp when the object was created.

updated_atstringOptionalformat: "date-time"

The timestamp when the object was last updated.

tool_ruleslist of objectsOptional

The list of tool rules.

message_idslist of stringsOptional

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

response_formatobjectOptional

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

descriptionstringOptional

The description of the agent.

metadataobjectOptional

The metadata of the agent.

tool_exec_environment_variableslist of objectsOptional

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_autoclearbooleanOptionalDefaults to false

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.

enable_sleeptimebooleanOptional

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

multi_agent_groupobjectOptional

The multi-agent group that this agent manages

Headers

Query parameters

Response