TypeScript SDK reference

npm install @agentmem/sdk

import { MemoryStore, AgentMemError, DEFAULT_BASE_URL } from '@agentmem/sdk'
 
const mem = new MemoryStore({
  apiKey:  process.env.AGENTMEM_API_KEY!,
  baseUrl: DEFAULT_BASE_URL,        // optional — override for self-hosting
})

const { writeId, duplicate } = await mem.write({
  content:    'Customer prefers email',
  agentId:    'support-bot',
  scope:      'team',
  role:       'executor',
  workflowId: 'wf-123',
  expiresAt:  new Date(Date.now() + 7*24*3600*1000).toISOString(),
})
 
const hits = await mem.search({
  query:   'customer preferences',
  agentId: 'support-bot',
  topK:    5,
  rerank:  true,
})
 
const history = await mem.getHistory(writeId)
// { memory, supersededBy: Memory | null, supersedes: Memory[] }

await mem.scratchSet({ workflowId: 'wf-123', key: 'entities', value: '...', ttlSecs: 3600 })
const v   = await mem.scratchGet('wf-123', 'entities')   // string | null
await mem.scratchDel('wf-123', 'entities')

const summary  = await mem.summarize('wf-123', 'support-bot')   // string
const memories = await mem.workflowMemories('wf-123')           // MemoryHit[]

const keys = await mem.listKeys()                  // ApiKey[]
const { key, id } = await mem.createKey({ name: 'prod' })   // shows full key once
await mem.revokeKey(id)

const teams = await mem.listTeams()
const team  = await mem.createTeam('billing')
await mem.deleteTeam(team.id)

const policies = await mem.listPolicies()
await mem.setPolicy({ policy: 'timestamp_wins', workflowId: 'wf-123' })
await mem.deletePolicy(policyId)

const webhooks = await mem.listWebhooks()
const { id, secret, ...rest } = await mem.createWebhook({
  url:    'https://your.app/hook',
  events: ['memory.written', 'memory.expired'],
})
 
await mem.enableWebhook(id)
await mem.disableWebhook(id)
await mem.deleteWebhook(id)

const grants = await mem.listGrants()
const grant  = await mem.createGrant({
  grantorRole:   'planner',
  granteeAgent:  'support-bot',
  resourceScope: 'private',
})
await mem.revokeGrant(grant.id)

await mem.registerByok(customerKeyBase64)
await mem.removeByok()
 
const retention = await mem.getRetention()
await mem.setRetention({ memoriesDays: 90, auditDays: 365, scratchDays: 7 })
 
const usage = await mem.getWorkflowUsage(30)
// { 'wf-123': { writes, searches }, ... }

import type {
  ClientOptions,
  WriteParams, WriteResult, SearchParams, MemoryHit, Memory, MemoryHistory,
  ConflictResult, Conflict, ScratchSetParams,
  ApiKey, CreateKeyParams, CreateKeyResult,
  Team,
  Policy, SetPolicyParams,
  Webhook, CreateWebhookParams, WebhookEvent,
  AccessGrant, CreateGrantParams,
  Retention, WorkflowUsage,
  BatchWriteResult, BatchSearchResult,
  Scope, Role, ConflictPolicy,
} from '@agentmem/sdk'