Memory API

What the Memory API does

Send timestamped text, wait for it to complete, then recall ranked memory with the data points behind it.

Copy page
View as Markdown

You send Harny data points: pieces of text with the time each one happened, such as a call transcript, an email, a chat message or a CRM note. Harny derives memory from them. A recall names a user and a question, and returns ranked memories, each with the data points it rests on.

The API accepts text from conversations, email, meetings, support records, CRM notes and documents. Each data point keeps your source id and the time it happened. Recall returns the memories that answer the question, with their dates and the data points behind each one.

Five nouns organize every call. An app is the isolation boundary, and an app key selects one. A data point is one thing that happened, sent with its own time. An audience is a named group of users. A user is the person a recall answers as. A trait is an attribute of a user that audience rules match on. Concepts defines each one.

Read the Quickstart first, then Setup for the complete procedure in order. Read Sending data before a historical load and Access control before the first customer goes live.

All routes use JSON under /v1/memory. The API reference documents every route.

  • POST /v1/memory/ingest accepts one data point, and POST /v1/memory/ingest/batch accepts a batch of up to 1,000. GET /v1/memory/ingest/{ingestionId} reports completion, and DELETE on the same route forgets the send.
  • POST /v1/memory/recall returns ranked memory for one user.
  • DELETE /v1/memory/data-points/{sourceId} and POST /v1/memory/data-points/delete delete data points by your own source id.
  • GET /v1/memory/usage returns the month's count of monthly-active end users.

Get API key