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         "model_endpoint": "string",
13         "provider_name": "string",
14         "provider_category": "base",
15         "model_wrapper": "string",
16         "put_inner_thoughts_in_kwargs": true,
17         "handle": "string",
18         "temperature": 0.7,
19         "max_tokens": 1,
20         "enable_reasoner": true,
21         "reasoning_effort": "minimal",
22         "max_reasoning_tokens": 0,
23         "frequency_penalty": 1.1,
24         "compatibility_type": "gguf",
25         "verbosity": "low",
26         "tier": "string"
27       },
28       "embedding_config": {
29         "embedding_endpoint_type": "openai",
30         "embedding_model": "string",
31         "embedding_dim": 1,
32         "embedding_endpoint": "string",
33         "embedding_chunk_size": 1,
34         "handle": "string",
35         "batch_size": 32,
36         "azure_endpoint": "string",
37         "azure_version": "string",
38         "azure_deployment": "string"
39       },
40       "memory": {
41         "blocks": [
42           {
43             "value": "string",
44             "limit": 20000,
45             "project_id": "string",
46             "name": "string",
47             "is_template": false,
48             "base_template_id": "string",
49             "deployment_id": "string",
50             "entity_id": "string",
51             "preserve_on_migration": true,
52             "label": "string",
53             "read_only": false,
54             "description": "string",
55             "metadata": {},
56             "hidden": true,
57             "id": "block-123e4567-e89b-12d3-a456-426614174000",
58             "created_by_id": "string",
59             "last_updated_by_id": "string"
60           }
61         ],
62         "agent_type": "memgpt_agent",
63         "file_blocks": [
64           {
65             "value": "string",
66             "file_id": "string",
67             "source_id": "string",
68             "is_open": true,
69             "limit": 20000,
70             "project_id": "string",
71             "name": "string",
72             "is_template": false,
73             "base_template_id": "string",
74             "deployment_id": "string",
75             "entity_id": "string",
76             "preserve_on_migration": true,
77             "label": "string",
78             "read_only": false,
79             "description": "string",
80             "metadata": {},
81             "hidden": true,
82             "id": "block-123e4567-e89b-12d3-a456-426614174000",
83             "created_by_id": "string",
84             "last_updated_by_id": "string",
85             "last_accessed_at": "2024-01-15T09:30:00Z"
86           }
87         ],
88         "prompt_template": ""
89       },
90       "tools": [
91         {
92           "id": "tool-123e4567-e89b-12d3-a456-426614174000",
93           "tool_type": "custom",
94           "description": "string",
95           "source_type": "string",
96           "name": "string",
97           "tags": [
98             "string"
99           ],
100           "source_code": "string",
101           "json_schema": {},
102           "args_json_schema": {},
103           "return_char_limit": 50000,
104           "pip_requirements": [
105             {
106               "name": "string",
107               "version": "string"
108             }
109           ],
110           "npm_requirements": [
111             {
112               "name": "string",
113               "version": "string"
114             }
115           ],
116           "default_requires_approval": true,
117           "created_by_id": "string",
118           "last_updated_by_id": "string",
119           "metadata_": {}
120         }
121       ],
122       "sources": [
123         {
124           "name": "string",
125           "embedding_config": {
126             "embedding_endpoint_type": "openai",
127             "embedding_model": "string",
128             "embedding_dim": 1,
129             "embedding_endpoint": "string",
130             "embedding_chunk_size": 1,
131             "handle": "string",
132             "batch_size": 32,
133             "azure_endpoint": "string",
134             "azure_version": "string",
135             "azure_deployment": "string"
136           },
137           "description": "string",
138           "instructions": "string",
139           "metadata": {},
140           "id": "source-123e4567-e89b-12d3-a456-426614174000",
141           "vector_db_provider": "native",
142           "created_by_id": "string",
143           "last_updated_by_id": "string",
144           "created_at": "2024-01-15T09:30:00Z",
145           "updated_at": "2024-01-15T09:30:00Z"
146         }
147       ],
148       "tags": [
149         "string"
150       ],
151       "created_by_id": "string",
152       "last_updated_by_id": "string",
153       "created_at": "2024-01-15T09:30:00Z",
154       "updated_at": "2024-01-15T09:30:00Z",
155       "tool_rules": [
156         {
157           "tool_name": "string",
158           "type": "constrain_child_tools",
159           "prompt_template": "string",
160           "children": [
161             "string"
162           ],
163           "child_arg_nodes": [
164             {
165               "name": "string",
166               "args": {}
167             }
168           ]
169         }
170       ],
171       "message_ids": [
172         "string"
173       ],
174       "response_format": {
175         "type": "text"
176       },
177       "description": "string",
178       "metadata": {},
179       "secrets": [
180         {
181           "key": "string",
182           "value": "string",
183           "agent_id": "string",
184           "created_by_id": "string",
185           "last_updated_by_id": "string",
186           "created_at": "2024-01-15T09:30:00Z",
187           "updated_at": "2024-01-15T09:30:00Z",
188           "id": "agent-env-123e4567-e89b-12d3-a456-426614174000",
189           "description": "string"
190         }
191       ],
192       "project_id": "string",
193       "template_id": "string",
194       "base_template_id": "string",
195       "deployment_id": "string",
196       "entity_id": "string",
197       "identity_ids": [
198         "string"
199       ],
200       "message_buffer_autoclear": false,
201       "enable_sleeptime": true,
202       "multi_agent_group": {
203         "id": "string",
204         "manager_type": "round_robin",
205         "agent_ids": [
206           "string"
207         ],
208         "description": "string",
209         "project_id": "string",
210         "template_id": "string",
211         "base_template_id": "string",
212         "deployment_id": "string",
213         "shared_block_ids": [
214           "string"
215         ],
216         "manager_agent_id": "string",
217         "termination_token": "string",
218         "max_turns": 1,
219         "sleeptime_agent_frequency": 1,
220         "turns_counter": 1,
221         "last_processed_message_id": "string",
222         "max_message_buffer_length": 1,
223         "min_message_buffer_length": 1,
224         "hidden": true
225       },
226       "last_run_completion": "2024-01-15T09:30:00Z",
227       "last_run_duration_ms": 1,
228       "timezone": "string",
229       "max_files_open": 1,
230       "per_file_view_window_char_limit": 1,
231       "hidden": true,
232       "tool_exec_environment_variables": [
233         {
234           "key": "string",
235           "value": "string",
236           "agent_id": "string",
237           "created_by_id": "string",
238           "last_updated_by_id": "string",
239           "created_at": "2024-01-15T09:30:00Z",
240           "updated_at": "2024-01-15T09:30:00Z",
241           "id": "agent-env-123e4567-e89b-12d3-a456-426614174000",
242           "description": "string"
243         }
244       ]
245     }
246   ],
247   "nextCursor": "string"
248 }

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