API reference.

A small REST surface. Stable since v1.0. Versioned URLs, a deprecation policy, and a full audit trail for every recall.

v1 · stableOpenAPI spec availableQuickstart →

01Authentication

Every request carries a Bearer token in the Authorization header. Keys are scoped to a single container by default; use a workspace-level key for cross-container audit work.

bashcurl
curl https://agentprizm.com/api/v1/agent/recall \
  -H "Authorization: Bearer ap_••••" \
  -H "Content-Type: application/json"

02POST /api/v1/agent/memories

Create one or more memories. Returns assigned IDs and any contradictions detected against existing memories. Send a single memory body, or batch with { memories: [...] }.

Request body

FieldTypeNotes
contentstringRequired. The memory itself.
typeenumRequired. fact · lesson · directive · preference · contact · bookmark
containersstring[]Optional. Containers this memory belongs to.
tagsstring[]Optional. Free-form tags for filtering.
sourceenumOptional. direct · conversation · capture · extraction · compaction
validFromISO 8601Optional. Defaults to creation time.
validUntilISO 8601Optional. Marks the memory stale after this date.
metadataobjectArbitrary JSON, queryable.

03POST /api/v1/agent/recall

Retrieve the most relevant memories for a query. Recall is hybrid semantic + keyword — set searchMode to semantic, keyword, or hybrid (the default). Filter by container, type, and time range.

jsonrequest
{
  "query": "when can we close?",
  "containers": ["acme-co"],
  "types": ["fact"],
  "limit": 5,
  "searchMode": "hybrid"
}
jsonresponse
{
  "memories": [
    {
      "id": "mem_01H...",
      "content": "Procurement freezes Dec 15 → Jan 5...",
      "type": "fact",
      "similarity": 0.94,
      "containers": ["acme-co"],
      "validUntil": "2026-12-31"
    }
  ]
}

04Memory object

Every memory has a stable ID, a confidence score (0–1), a type, and provenance. Updates create a new version, and contradictions shadow rather than overwrite. Read or edit a single memory at GET / PATCH / DELETE /api/v1/agent/memories/:id.

05GET /api/v1/agent/stats

Fetch usage stats and your plan limits — memories stored, recalls used, and remaining quota. Stats queries don't bill against your quota.

bashcurl
curl https://agentprizm.com/api/v1/agent/stats \
  -H "Authorization: Bearer ap_••••"

06Errors

CodeStatusMeaning
invalid_request400Malformed body or missing field.
auth_failed401Bad or expired API key.
forbidden403Key not scoped to this container.
not_found404Memory or trace ID doesn't exist.
quota_exhausted429Plan cap hit. See retry-after.
rate_limited429Too many concurrent requests.
server_error500Something on our end. Retries are safe.

07Rate limits

Default rate limit is 100 RPS per API key, burstable to 500 for 10 seconds. Enterprise keys are negotiated. All endpoints honor the standard X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.

Need integration help?

Stuck on a tricky integration?

Our solutions engineers help design partners ship in days, not weeks. Send the snippet, we'll send the fix.

Ship agents that remember.

Six lines of code. Confidence scores, validity windows, and audit trails included. Free until your agents ship.

Talk to us