Agent Endpoints

Spawn, manage, and communicate with agents. Agents are autonomous entities with their own memory contexts, capable of processing messages and executing tasks using their accumulated knowledge.

Overview

The agent API lets you create and manage agents that have their own isolated memory contexts. Each agent accumulates episodic, semantic, and procedural memories through interactions. Agents can be members of hives to share collective knowledge.

MethodEndpointDescription
POST/v1/agents/spawnSpawn a new agent
GET/v1/agentsList agents
GET/v1/agents/:idGet a specific agent
PUT/v1/agents/:idUpdate an agent
DELETE/v1/agents/:idDelete an agent
POST/v1/agents/:id/messageSend a message to an agent

Spawn Agent

List Agents

Get Agent

Update Agent

Delete Agent

Destructive action

Deleting an agent permanently removes all of its memories and cannot be undone. Consider deactivating the agent instead by updating its status to inactive if you may need the agent or its memories later.

Send Message

Memory consultation

The memories_consulted field in the response shows which memories the agent used to inform its response, along with their relevance scores. This is useful for debugging and understanding the agent's reasoning.

Agent Object

The following table describes all fields in an agent object.

FieldTypeDescription
idstringUnique agent identifier (prefixed with agent_)
namestringHuman-readable agent name
descriptionstringAgent description and purpose
statusstringAgent status: active, inactive, terminated
configobjectAgent configuration (model, temperature, memory settings)
memory_countintegerTotal number of memories in the agent's context
message_countintegerTotal messages processed by the agent
hivesarrayList of hive IDs the agent belongs to
metadataobjectArbitrary key-value metadata
created_atstringISO 8601 creation timestamp
last_active_atstringISO 8601 timestamp of last activity
Rekall
rekall