List Agents

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

1 [ 2 { 3 "id": "id", 4 "name": "name", 5 "system": "system", 6 "agent_type": "memgpt_agent", 7 "llm_config": { 8 "model": "model", 9 "model_endpoint_type": "openai", 10 "context_window": 1, 11 "model_endpoint": "model_endpoint", 12 "model_wrapper": "model_wrapper", 13 "put_inner_thoughts_in_kwargs": true, 14 "handle": "handle", 15 "temperature": 1.1, 16 "max_tokens": 1, 17 "enable_reasoner": true, 18 "reasoning_effort": "low", 19 "max_reasoning_tokens": 1 20 }, 21 "embedding_config": { 22 "embedding_endpoint_type": "openai", 23 "embedding_model": "embedding_model", 24 "embedding_dim": 1, 25 "embedding_endpoint": "embedding_endpoint", 26 "embedding_chunk_size": 1, 27 "handle": "handle", 28 "azure_endpoint": "azure_endpoint", 29 "azure_version": "azure_version", 30 "azure_deployment": "azure_deployment" 31 }, 32 "memory": { 33 "blocks": [ 34 { 35 "value": "value", 36 "id": "block-123e4567-e89b-12d3-a456-426614174000" 37 } 38 ], 39 "prompt_template": "prompt_template" 40 }, 41 "tools": [ 42 { 43 "id": "tool-123e4567-e89b-12d3-a456-426614174000" 44 } 45 ], 46 "sources": [ 47 { 48 "name": "name", 49 "embedding_config": { 50 "embedding_endpoint_type": "openai", 51 "embedding_model": "embedding_model", 52 "embedding_dim": 1 53 }, 54 "id": "source-123e4567-e89b-12d3-a456-426614174000" 55 } 56 ], 57 "tags": [ 58 "tags" 59 ], 60 "created_by_id": "created_by_id", 61 "last_updated_by_id": "last_updated_by_id", 62 "created_at": "2024-01-15T09:30:00Z", 63 "updated_at": "2024-01-15T09:30:00Z", 64 "tool_rules": [ 65 { 66 "tool_name": "tool_name", 67 "type": "conditional", 68 "child_output_mapping": { 69 "key": "value" 70 } 71 } 72 ], 73 "message_ids": [ 74 "message_ids" 75 ], 76 "description": "description", 77 "metadata": { 78 "key": "value" 79 }, 80 "tool_exec_environment_variables": [ 81 { 82 "key": "key", 83 "value": "value", 84 "agent_id": "agent_id", 85 "id": "agent-env-123e4567-e89b-12d3-a456-426614174000" 86 } 87 ], 88 "project_id": "project_id", 89 "template_id": "template_id", 90 "base_template_id": "base_template_id", 91 "identity_ids": [ 92 "identity_ids" 93 ], 94 "message_buffer_autoclear": true, 95 "enable_sleeptime": true, 96 "multi_agent_group": { 97 "id": "id", 98 "manager_type": "round_robin", 99 "agent_ids": [ 100 "agent_ids" 101 ], 102 "description": "description", 103 "shared_block_ids": [ 104 "shared_block_ids" 105 ], 106 "manager_agent_id": "manager_agent_id", 107 "termination_token": "termination_token", 108 "max_turns": 1, 109 "sleeptime_agent_frequency": 1, 110 "turns_counter": 1, 111 "last_processed_message_id": "last_processed_message_id" 112 } 113 } 114 ]

List all agents associated with a given user.

This endpoint retrieves a list of all agents and their configurations associated with the specified user ID.

Query parameters

namestringOptional

Name of the agent

tagsstringOptional

List of tags to filter agents by

match_all_tagsbooleanOptionalDefaults to false

If True, only returns agents that match ALL given tags. Otherwise, return agents that have ANY of the passed-in tags.

beforestringOptional

Cursor for pagination

afterstringOptional

Cursor for pagination

limitintegerOptional

Limit for pagination

query_textstringOptional

Search agents by name

project_idstringOptional

Search agents by project ID

template_idstringOptional

Search agents by template ID

base_template_idstringOptional

Search agents by base template ID

identity_idstringOptional

Search agents by identity ID

identifier_keysstringOptional

Search agents by identifier keys

include_relationshipsstringOptional

Specify which relational fields (e.g., ‘tools’, ‘sources’, ‘memory’) to include in the response. If not provided, all relationships are loaded by default. Using this can optimize performance by reducing unnecessary joins.

ascendingbooleanOptionalDefaults to false

Whether to sort agents oldest to newest (True) or newest to oldest (False, default)

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.

Allowed values:

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_atdatetimeOptional

The timestamp when the object was created.

updated_atdatetimeOptional

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.

descriptionstringOptional

The description of the agent.

metadatamap from strings to anyOptional

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

Errors