Get Agent State

GET

/v1/agents/:agent_id

Get the state of the agent.

Path parameters

agent_idstringRequired

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

Allowed values: memgpt_agentsplit_thread_agento1_agentoffline_memory_agentchat_only_agent

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_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp when the object was created.

updated_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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.

organization_idstringOptional

The unique identifier of the organization associated with the agent.

descriptionstringOptional

The description of the agent.

metadata_map from strings to anyOptional

The metadata of the agent.

Errors

GET

1 curl https://app.letta.com/v1/agents/agent_id \
2      -H "Authorization: Bearer <token>"

1 {
2   "id": "id",
3   "name": "name",
4   "system": "system",
5   "agent_type": "memgpt_agent",
6   "llm_config": {
7     "model": "model",
8     "model_endpoint_type": "openai",
9     "context_window": 1,
10     "model_endpoint": "model_endpoint",
11     "model_wrapper": "model_wrapper",
12     "put_inner_thoughts_in_kwargs": true,
13     "handle": "handle"
14   },
15   "embedding_config": {
16     "embedding_endpoint_type": "openai",
17     "embedding_model": "embedding_model",
18     "embedding_dim": 1,
19     "embedding_endpoint": "embedding_endpoint",
20     "embedding_chunk_size": 1,
21     "handle": "handle",
22     "azure_endpoint": "azure_endpoint",
23     "azure_version": "azure_version",
24     "azure_deployment": "azure_deployment"
25   },
26   "memory": {
27     "blocks": [
28       {
29         "value": "value",
30         "id": "block-123e4567-e89b-12d3-a456-426614174000"
31       }
32     ],
33     "prompt_template": "prompt_template"
34   },
35   "tools": [
36     {
37       "source_code": "source_code",
38       "id": "tool-123e4567-e89b-12d3-a456-426614174000",
39       "description": "description",
40       "source_type": "source_type",
41       "module": "module",
42       "organization_id": "organization_id",
43       "name": "name",
44       "tags": [
45         "tags"
46       ],
47       "json_schema": {
48         "key": "value"
49       },
50       "return_char_limit": 1,
51       "created_by_id": "created_by_id",
52       "last_updated_by_id": "last_updated_by_id"
53     }
54   ],
55   "sources": [
56     {
57       "name": "name",
58       "embedding_config": {
59         "embedding_endpoint_type": "openai",
60         "embedding_model": "embedding_model",
61         "embedding_dim": 1
62       },
63       "id": "source-123e4567-e89b-12d3-a456-426614174000",
64       "description": "description",
65       "organization_id": "organization_id",
66       "metadata_": {
67         "key": "value"
68       },
69       "created_by_id": "created_by_id",
70       "last_updated_by_id": "last_updated_by_id",
71       "created_at": "2024-01-15T09:30:00Z",
72       "updated_at": "2024-01-15T09:30:00Z"
73     }
74   ],
75   "tags": [
76     "tags"
77   ],
78   "created_by_id": "created_by_id",
79   "last_updated_by_id": "last_updated_by_id",
80   "created_at": "2024-01-15T09:30:00Z",
81   "updated_at": "2024-01-15T09:30:00Z",
82   "tool_rules": [
83     {
84       "tool_name": "tool_name",
85       "type": "InitToolRule",
86       "children": [
87         "children"
88       ]
89     }
90   ],
91   "message_ids": [
92     "message_ids"
93   ],
94   "organization_id": "organization_id",
95   "description": "description",
96   "metadata_": {
97     "key": "value"
98   }
99 }

Delete Agent

Up Next

Built with

1	curl https://app.letta.com/v1/agents/agent_id \
2	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"name": "name",
4	"system": "system",
5	"agent_type": "memgpt_agent",
6	"llm_config": {
7	"model": "model",
8	"model_endpoint_type": "openai",
9	"context_window": 1,
10	"model_endpoint": "model_endpoint",
11	"model_wrapper": "model_wrapper",
12	"put_inner_thoughts_in_kwargs": true,
13	"handle": "handle"
14	},
15	"embedding_config": {
16	"embedding_endpoint_type": "openai",
17	"embedding_model": "embedding_model",
18	"embedding_dim": 1,
19	"embedding_endpoint": "embedding_endpoint",
20	"embedding_chunk_size": 1,
21	"handle": "handle",
22	"azure_endpoint": "azure_endpoint",
23	"azure_version": "azure_version",
24	"azure_deployment": "azure_deployment"
25	},
26	"memory": {
27	"blocks": [
28	{
29	"value": "value",
30	"id": "block-123e4567-e89b-12d3-a456-426614174000"
31	}
32	],
33	"prompt_template": "prompt_template"
34	},
35	"tools": [
36	{
37	"source_code": "source_code",
38	"id": "tool-123e4567-e89b-12d3-a456-426614174000",
39	"description": "description",
40	"source_type": "source_type",
41	"module": "module",
42	"organization_id": "organization_id",
43	"name": "name",
44	"tags": [
45	"tags"
46	],
47	"json_schema": {
48	"key": "value"
49	},
50	"return_char_limit": 1,
51	"created_by_id": "created_by_id",
52	"last_updated_by_id": "last_updated_by_id"
53	}
54	],
55	"sources": [
56	{
57	"name": "name",
58	"embedding_config": {
59	"embedding_endpoint_type": "openai",
60	"embedding_model": "embedding_model",
61	"embedding_dim": 1
62	},
63	"id": "source-123e4567-e89b-12d3-a456-426614174000",
64	"description": "description",
65	"organization_id": "organization_id",
66	"metadata_": {
67	"key": "value"
68	},
69	"created_by_id": "created_by_id",
70	"last_updated_by_id": "last_updated_by_id",
71	"created_at": "2024-01-15T09:30:00Z",
72	"updated_at": "2024-01-15T09:30:00Z"
73	}
74	],
75	"tags": [
76	"tags"
77	],
78	"created_by_id": "created_by_id",
79	"last_updated_by_id": "last_updated_by_id",
80	"created_at": "2024-01-15T09:30:00Z",
81	"updated_at": "2024-01-15T09:30:00Z",
82	"tool_rules": [
83	{
84	"tool_name": "tool_name",
85	"type": "InitToolRule",
86	"children": [
87	"children"
88	]
89	}
90	],
91	"message_ids": [
92	"message_ids"
93	],
94	"organization_id": "organization_id",
95	"description": "description",
96	"metadata_": {
97	"key": "value"
98	}
99	}