Skip to content
DashboardGet API key

Get an item

View .md
GET

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • collectionstringrequired

    Collection name.

  • keystringrequired

    Item key. 1-255 chars from A-Z a-z 0-9 . _ : @ -

Query parameters

  • scopestring

    Which scope to address: contact:<contactId>, conversation:<conversationId>, or omitted for the project scope.

    Note the asymmetry with POST /v1/memory and POST /v1/memory/search, which take the scope in the request BODY as scope plus contactId/conversationId. Every other Memory endpoint takes it here.

Responses

200The item.
  • itemobjectrequired

    One JSON document in a collection.

    6 properties
    • keystringrequired
    • valueany

      The stored JSON. Any JSON value.

    • revintegerrequired

      Revision, incremented on every write. Pass it as If-Match on a later write to make that write conditional.

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
    • expiresAtstring<date-time>
400Invalid collection name, key, or `scope`.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404`collection_not_found` or `item_not_found`. An item written in one scope is not found in another — pass the same `?scope=`.
  • codestringrequired
  • messagestringrequired
  • detailsobject