Skip to main content
GET
Get Agent Memory Schema

Overview

Returns the memory entity schema the agent runs with today: the kinds of things it tracks per contact, such as a booking or an order, and the fields it fills in for each one. The schema comes from one of two places, and source tells you which. When the newest dev version carries settings.memorySchema, that is returned and source is settings. Otherwise the last schema the runtime inferred and cached is returned with source set to cached_version. An agent with neither returns an empty list and source of null, which means nothing is known yet rather than that the agent remembers nothing. To produce a schema for an agent that has none, use Infer Agent Memory Schema.

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The agent’s unique identifier.

Response

array
The entity types the agent tracks per contact. Empty when nothing is known yet.
string | null
Where the schema came from: settings when it is saved on the agent’s newest dev version, cached_version when it was inferred by the runtime, or null when entity_schemas is empty.
null | array
null on success, or a list of error objects if the request failed.

Docs for agents: llms.txt