Search Agents

POST

/v1/agents/search

POST

/v1/agents/search

1 import { LettaClient } from "@letta-ai/letta-client";
2 
3 const client = new LettaClient({ token: "YOUR_TOKEN", project: "YOUR_PROJECT" });
4 await client.agents.search();

Try it

200Successful

1 {
2   "agents": [
3     {
4       "id": "string",
5       "name": "string",
6       "system": "string",
7       "agent_type": "memgpt_agent",
8       "llm_config": {
9         "model": "string",
10         "model_endpoint_type": "openai",
11         "context_window": 1,
12         "display_name": "string",
13         "model_endpoint": "string",
14         "provider_name": "string",
15         "provider_category": "base",
16         "model_wrapper": "string",
17         "put_inner_thoughts_in_kwargs": true,
18         "handle": "string",
19         "temperature": 0.7,
20         "max_tokens": 1,
21         "enable_reasoner": true,
22         "reasoning_effort": "minimal",
23         "max_reasoning_tokens": 0,
24         "frequency_penalty": 1.1,
25         "compatibility_type": "gguf",
26         "verbosity": "low",
27         "tier": "string",
28         "parallel_tool_calls": true
29       },
30       "embedding_config": {
31         "embedding_endpoint_type": "openai",
32         "embedding_model": "string",
33         "embedding_dim": 1,
34         "embedding_endpoint": "string",
35         "embedding_chunk_size": 1,
36         "handle": "string",
37         "batch_size": 32,
38         "azure_endpoint": "string",
39         "azure_version": "string",
40         "azure_deployment": "string"
41       },
42       "memory": {
43         "blocks": [
44           {
45             "value": "string",
46             "limit": 20000,
47             "project_id": "string",
48             "template_name": "string",
49             "is_template": false,
50             "template_id": "string",
51             "base_template_id": "string",
52             "deployment_id": "string",
53             "entity_id": "string",
54             "preserve_on_migration": true,
55             "label": "string",
56             "read_only": false,
57             "description": "string",
58             "metadata": {},
59             "hidden": true,
60             "id": "block-123e4567-e89b-12d3-a456-426614174000",
61             "created_by_id": "string",
62             "last_updated_by_id": "string"
63           }
64         ],
65         "agent_type": "memgpt_agent",
66         "file_blocks": [
67           {
68             "value": "string",
69             "file_id": "string",
70             "source_id": "string",
71             "is_open": true,
72             "limit": 20000,
73             "project_id": "string",
74             "template_name": "string",
75             "is_template": false,
76             "template_id": "string",
77             "base_template_id": "string",
78             "deployment_id": "string",
79             "entity_id": "string",
80             "preserve_on_migration": true,
81             "label": "string",
82             "read_only": false,
83             "description": "string",
84             "metadata": {},
85             "hidden": true,
86             "id": "block-123e4567-e89b-12d3-a456-426614174000",
87             "created_by_id": "string",
88             "last_updated_by_id": "string",
89             "last_accessed_at": "2024-01-15T09:30:00Z"
90           }
91         ],
92         "prompt_template": ""
93       },
94       "blocks": [
95         {
96           "value": "string",
97           "limit": 20000,
98           "project_id": "string",
99           "template_name": "string",
100           "is_template": false,
101           "template_id": "string",
102           "base_template_id": "string",
103           "deployment_id": "string",
104           "entity_id": "string",
105           "preserve_on_migration": true,
106           "label": "string",
107           "read_only": false,
108           "description": "string",
109           "metadata": {},
110           "hidden": true,
111           "id": "block-123e4567-e89b-12d3-a456-426614174000",
112           "created_by_id": "string",
113           "last_updated_by_id": "string"
114         }
115       ],
116       "tools": [
117         {
118           "id": "tool-123e4567-e89b-12d3-a456-426614174000",
119           "tool_type": "custom",
120           "description": "string",
121           "source_type": "string",
122           "name": "string",
123           "tags": [
124             "string"
125           ],
126           "source_code": "string",
127           "json_schema": {},
128           "args_json_schema": {},
129           "return_char_limit": 50000,
130           "pip_requirements": [
131             {
132               "name": "string",
133               "version": "string"
134             }
135           ],
136           "npm_requirements": [
137             {
138               "name": "string",
139               "version": "string"
140             }
141           ],
142           "default_requires_approval": true,
143           "enable_parallel_execution": true,
144           "created_by_id": "string",
145           "last_updated_by_id": "string",
146           "metadata_": {}
147         }
148       ],
149       "sources": [
150         {
151           "name": "string",
152           "embedding_config": {
153             "embedding_endpoint_type": "openai",
154             "embedding_model": "string",
155             "embedding_dim": 1,
156             "embedding_endpoint": "string",
157             "embedding_chunk_size": 1,
158             "handle": "string",
159             "batch_size": 32,
160             "azure_endpoint": "string",
161             "azure_version": "string",
162             "azure_deployment": "string"
163           },
164           "description": "string",
165           "instructions": "string",
166           "metadata": {},
167           "id": "source-123e4567-e89b-12d3-a456-426614174000",
168           "vector_db_provider": "native",
169           "created_by_id": "string",
170           "last_updated_by_id": "string",
171           "created_at": "2024-01-15T09:30:00Z",
172           "updated_at": "2024-01-15T09:30:00Z"
173         }
174       ],
175       "tags": [
176         "string"
177       ],
178       "created_by_id": "string",
179       "last_updated_by_id": "string",
180       "created_at": "2024-01-15T09:30:00Z",
181       "updated_at": "2024-01-15T09:30:00Z",
182       "tool_rules": [
183         {
184           "tool_name": "string",
185           "type": "constrain_child_tools",
186           "prompt_template": "string",
187           "children": [
188             "string"
189           ],
190           "child_arg_nodes": [
191             {
192               "name": "string",
193               "args": {}
194             }
195           ]
196         }
197       ],
198       "message_ids": [
199         "string"
200       ],
201       "response_format": {
202         "type": "text"
203       },
204       "description": "string",
205       "metadata": {},
206       "secrets": [
207         {
208           "key": "string",
209           "value": "string",
210           "agent_id": "string",
211           "created_by_id": "string",
212           "last_updated_by_id": "string",
213           "created_at": "2024-01-15T09:30:00Z",
214           "updated_at": "2024-01-15T09:30:00Z",
215           "id": "agent-env-123e4567-e89b-12d3-a456-426614174000",
216           "description": "string",
217           "value_enc": "string"
218         }
219       ],
220       "project_id": "string",
221       "template_id": "string",
222       "base_template_id": "string",
223       "deployment_id": "string",
224       "entity_id": "string",
225       "identities": [
226         {
227           "identifier_key": "string",
228           "name": "string",
229           "identity_type": "org",
230           "agent_ids": [
231             "string"
232           ],
233           "block_ids": [
234             "string"
235           ],
236           "id": "identity-123e4567-e89b-12d3-a456-426614174000",
237           "project_id": "string",
238           "properties": [
239             {
240               "key": "string",
241               "value": {},
242               "type": "string"
243             }
244           ]
245         }
246       ],
247       "message_buffer_autoclear": false,
248       "enable_sleeptime": true,
249       "managed_group": {
250         "id": "string",
251         "manager_type": "round_robin",
252         "agent_ids": [
253           "string"
254         ],
255         "description": "string",
256         "project_id": "string",
257         "template_id": "string",
258         "base_template_id": "string",
259         "deployment_id": "string",
260         "manager_agent_id": "string",
261         "termination_token": "string",
262         "max_turns": 1,
263         "sleeptime_agent_frequency": 1,
264         "turns_counter": 1,
265         "last_processed_message_id": "string",
266         "max_message_buffer_length": 1,
267         "min_message_buffer_length": 1,
268         "hidden": true,
269         "shared_block_ids": [
270           "string"
271         ]
272       },
273       "last_run_completion": "2024-01-15T09:30:00Z",
274       "last_run_duration_ms": 1,
275       "timezone": "string",
276       "max_files_open": 1,
277       "per_file_view_window_char_limit": 1,
278       "hidden": true,
279       "tool_exec_environment_variables": [
280         {
281           "key": "string",
282           "value": "string",
283           "agent_id": "string",
284           "created_by_id": "string",
285           "last_updated_by_id": "string",
286           "created_at": "2024-01-15T09:30:00Z",
287           "updated_at": "2024-01-15T09:30:00Z",
288           "id": "agent-env-123e4567-e89b-12d3-a456-426614174000",
289           "description": "string",
290           "value_enc": "string"
291         }
292       ],
293       "identity_ids": [
294         "string"
295       ],
296       "multi_agent_group": {
297         "id": "string",
298         "manager_type": "round_robin",
299         "agent_ids": [
300           "string"
301         ],
302         "description": "string",
303         "project_id": "string",
304         "template_id": "string",
305         "base_template_id": "string",
306         "deployment_id": "string",
307         "manager_agent_id": "string",
308         "termination_token": "string",
309         "max_turns": 1,
310         "sleeptime_agent_frequency": 1,
311         "turns_counter": 1,
312         "last_processed_message_id": "string",
313         "max_message_buffer_length": 1,
314         "min_message_buffer_length": 1,
315         "hidden": true,
316         "shared_block_ids": [
317           "string"
318         ]
319       }
320     }
321   ],
322   "nextCursor": "string"
323 }

This endpoint is only available on Letta Cloud.

Search deployed agents.

<Note>This endpoint is only available on Letta Cloud.</Note> Search deployed agents.

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Request

Body

searchlist of objectsOptional

project_idstringOptional

combinatorenumOptional

Allowed values:

limitdoubleOptional

afterstring or nullOptional

sortByenumOptional

Allowed values:

ascendingbooleanOptional

Response

200

agentslist of objects

nextCursorstring or null