Search Deployed Agents

POST

/v1/agents/search

POST

/v1/agents/search

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

Try it

200

1 {
2   "agents": [
3     {
4       "id": "foo",
5       "name": "foo",
6       "system": "foo",
7       "agent_type": "memgpt_agent",
8       "llm_config": {
9         "model": "foo",
10         "model_endpoint_type": "openai",
11         "context_window": 42,
12         "model_endpoint": "foo",
13         "provider_name": "foo",
14         "provider_category": "base",
15         "model_wrapper": "foo",
16         "put_inner_thoughts_in_kwargs": true,
17         "handle": "foo",
18         "temperature": 0.7,
19         "max_tokens": 42,
20         "enable_reasoner": false,
21         "reasoning_effort": "low",
22         "max_reasoning_tokens": 0
23       },
24       "embedding_config": {
25         "embedding_endpoint_type": "openai",
26         "embedding_model": "foo",
27         "embedding_dim": 42,
28         "embedding_endpoint": "foo",
29         "embedding_chunk_size": 42,
30         "handle": "foo",
31         "azure_endpoint": "foo",
32         "azure_version": "foo",
33         "azure_deployment": "foo"
34       },
35       "memory": {
36         "blocks": [
37           {
38             "value": "foo",
39             "limit": 5000,
40             "name": "foo",
41             "is_template": false,
42             "preserve_on_migration": true,
43             "label": "foo",
44             "read_only": false,
45             "description": "foo",
46             "metadata": {},
47             "id": "block-123e4567-e89b-12d3-a456-426614174000",
48             "created_by_id": "foo",
49             "last_updated_by_id": "foo"
50           }
51         ],
52         "file_blocks": [
53           {
54             "value": "foo",
55             "limit": 5000,
56             "name": "foo",
57             "is_template": false,
58             "preserve_on_migration": true,
59             "label": "foo",
60             "read_only": false,
61             "description": "foo",
62             "metadata": {},
63             "id": "block-123e4567-e89b-12d3-a456-426614174000",
64             "created_by_id": "foo",
65             "last_updated_by_id": "foo"
66           }
67         ],
68         "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 %}"
69       },
70       "tools": [
71         {
72           "id": "tool-123e4567-e89b-12d3-a456-426614174000",
73           "tool_type": "custom",
74           "description": "foo",
75           "source_type": "foo",
76           "name": "foo",
77           "tags": [
78             "foo"
79           ],
80           "source_code": "foo",
81           "json_schema": {},
82           "args_json_schema": {},
83           "return_char_limit": 6000,
84           "pip_requirements": [
85             {
86               "name": "foo",
87               "version": "foo"
88             }
89           ],
90           "created_by_id": "foo",
91           "last_updated_by_id": "foo",
92           "metadata_": {}
93         }
94       ],
95       "sources": [
96         {
97           "name": "foo",
98           "embedding_config": {
99             "embedding_endpoint_type": "openai",
100             "embedding_model": "foo",
101             "embedding_dim": 42,
102             "embedding_endpoint": "foo",
103             "embedding_chunk_size": 42,
104             "handle": "foo",
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     }
187   ],
188   "nextCursor": "foo"
189 }

This endpoint is only available on Letta Cloud.

Search deployed agents.

Request

Body

searchlist of objectsOptional

project_idstringOptional

combinatorenumOptional

Allowed values:

limitintegerOptional

afterstringOptional

sortByenumOptional

Allowed values:

ascendingbooleanOptional

Response

200

agentslist of objects

nextCursorstring or null

Headers

Request

Response