POST
/
v1
/
agents
/

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

user_id
string | null

Body

application/json
description
string | null

The description of the agent.

metadata_
object | null

The metadata of the agent.

user_id
string | null

The user id of the agent.

name
string | null

The name of the agent.

message_ids
string[] | null

The ids of the messages in the agent's in-context memory.

memory
object | null

The in-context memory of the agent.

tools
string[] | null

The tools used by the agent.

system
string | null

The system prompt used by the agent.

agent_type
enum<string> | null

The type of agent.

Available options:
memgpt_agent,
split_thread_agent
llm_config
object | null

The LLM configuration used by the agent.

embedding_config
object | null

The embedding configuration used by the agent.

Response

200 - application/json

Representation of an agent's state. This is the state of the agent at a given time, and is persisted in the DB backend. The state has all the information needed to recreate a persisted agent.

Parameters: id (str): The unique identifier of the agent. name (str): The name of the agent (must be unique to the user). created_at (datetime): The datetime the agent was created. message_ids (List[str]): The ids of the messages in the agent's in-context memory. memory (Memory): The in-context memory of the agent. tools (List[str]): The tools used by the agent. This includes any memory editing functions specified in memory. system (str): The system prompt used by the agent. llm_config (LLMConfig): The LLM configuration used by the agent. embedding_config (EmbeddingConfig): The embedding configuration used by the agent.

name
string
required

The name of the agent.

tools
string[]
required

The tools used by the agent.

system
string
required

The system prompt used by the agent.

agent_type
enum<string>
required

The type of agent.

Available options:
memgpt_agent,
split_thread_agent
llm_config
object
required

The LLM configuration used by the agent.

embedding_config
object
required

The embedding configuration used by the agent.

description
string | null

The description of the agent.

metadata_
object | null

The metadata of the agent.

user_id
string | null

The user id of the agent.

id
string

The human-friendly ID of the Agent

created_at
string

The datetime the agent was created.

message_ids
string[] | null

The ids of the messages in the agent's in-context memory.

memory
object

The in-context memory of the agent.

List AgentsGet Agent Context Window