Memory

Wabee Agent Core API (v1)

Wabee Agent Core API

Wabee Agent Core API enables developers to interact with an AI agent in a custom, secure and flexible manner through REST API calls.

One can build applications to interact with the agent API to complete a task using any of the Agents endpoints which allow for both text streaming and direct JSON response. The Memory endpoints are useful for managing the agent memory programatically. Moreover, the Metrics endpoints provide an interface for monitoring the underlying Agent in terms of latency, health, token consumption and much more.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License Wabee License
Languages
Servers
Mock server
https://api.docs.wabee.ai/_mock/openapi/
Production server
https://<your_agent_uri>.wabee.ai/

Agent

Endpoints for interacting with the AI agent

Operations

Memory

Endpoints for managing agent memory

Operations

Retrieve a list of memories

Request

Use this endpoint to fetch the agent memory.

Query
module_idstring(Module Id)required
curl -i -X GET \
  'https://api.docs.wabee.ai/_mock/openapi/core/v1/memory/list?module_id=string' \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Searche semantically related memories

Request

Use this endpoint to search for facts in the agent memory.

Query
querystring(Query)required
module_idstring(Module Id)
Default "agent_memory"
curl -i -X GET \
  'https://api.docs.wabee.ai/_mock/openapi/core/v1/memory/search?module_id=agent_memory&query=string' \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Add a new observation to the agent memory

Request

Use this endpoint to include a new observation to the agent memory. The agent will retrieve relevant memories based on the context of the user input and the recency of the observation for every new interaction via /chain or /chain_streamming endpoints.

Addition Strategies: Naive --> Simply appends current observation to memory Delete --> Removes old memories that conflict with current memory Update --> Updates old memories that conflict with current memory, and alters their content to reflect the fact that they are no longer "true".

The memory of each agent is eventual consistent. If there are multiples instances of the same agent running, all of them can modify the memory and eventually all of them will have the same memory state.

Query
module_idstring(Module Id)
Default "agent_memory"
Bodyapplication/jsonrequired
module_idstring(Module Id)required

Name of the module to insert

addition_strategystring(Addition Strategy)

Strategy to add the memory

Default "naive"
Enum"naive""delete""update"
inputInput (string) or Array of Input (strings)(Input)required

The data to be added to the memory

Any of:

The data to be added to the memory

string(Input)

The data to be added to the memory

curl -i -X POST \
  'https://api.docs.wabee.ai/_mock/openapi/core/v1/memory/observation?module_id=agent_memory' \
  -H 'Content-Type: application/json' \
  -H 'x-wabee-access: YOUR_API_KEY_HERE' \
  -d '{
    "module_id": "agent_memory",
    "addition_strategy": "update",
    "input": "This is a test observation"
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Clears training memory

Request

curl -i -X POST \
  https://api.docs.wabee.ai/_mock/openapi/core/v1/memory/discard \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "body": "Memories discarded"
}

Merges training memory with agent memory

Request

curl -i -X POST \
  https://api.docs.wabee.ai/_mock/openapi/core/v1/memory/commit \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
"Memories committed"

Observability

Endpoints for monitoring agent performance and logs

Operations