Skip to main content
POST
/
api
/
v1
/
memory
/
retrieve
Retrieve Memory
curl --request POST \
  --url https://api.promptguard.dev/api/v1/memory/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "<string>",
  "query": "<string>",
  "top_k": 5,
  "min_relevance": 0.5,
  "session_id": "<string>"
}
'
{
  "agent_id": "<string>",
  "query": "<string>",
  "memories": [
    {
      "content": "<string>",
      "relevance": 123,
      "created_at": "<string>",
      "metadata": {}
    }
  ],
  "total_searched": 123,
  "tokens_saved_estimate": 123
}

Authorizations

Authorization
string
header
required

API Key authentication for developer endpoints (/api/v1/*). Use format: 'Bearer pg_api_your_key_here'

Headers

x-api-key
string | null

Body

application/json

Request to retrieve relevant memories

agent_id
string
required
query
string
required
top_k
integer
default:5
min_relevance
number
default:0.5
session_id
string | null

Response

Successful Response

Response with retrieved memories

agent_id
string
required
query
string
required
memories
MemoryEntry · object[]
required
total_searched
integer
required
tokens_saved_estimate
integer
required