Read memory - Entendre Docs

cURL

curl --request GET \
  --url 'https://api.entendre.finance/v1/memory/file?path=knowledge/vendors.md' \
  --header 'X-API-Key: <api-key>'

const response = await fetch('https://api.entendre.finance/v1/memory/file?path=knowledge/vendors.md', {
  method: 'GET',
  headers: {
    'X-API-Key': '<api-key>',
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.entendre.finance/v1/memory/file",
    params={
        "path": "knowledge/vendors.md"
    },
    headers={"X-API-Key": "<api-key>"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

{
  "success": true,
  "documents": [
    {
      "path": "knowledge/vendors.md",
      "layer": "org",
      "version": "version-example",
      "content": "Treat approved staking rewards as revenue.",
      "frontmatter": null,
      "suppressed": false
    }
  ],
  "truncated": false,
  "next_cursor": null
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid path, query or request body.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient access to organization",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 30s.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "PROVIDER_ERROR",
    "message": "The memory service is temporarily unavailable.",
    "request_id": "req_example"
  }
}

GET

memory

file

cURL

curl --request GET \
  --url 'https://api.entendre.finance/v1/memory/file?path=knowledge/vendors.md' \
  --header 'X-API-Key: <api-key>'

const response = await fetch('https://api.entendre.finance/v1/memory/file?path=knowledge/vendors.md', {
  method: 'GET',
  headers: {
    'X-API-Key': '<api-key>',
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.entendre.finance/v1/memory/file",
    params={
        "path": "knowledge/vendors.md"
    },
    headers={"X-API-Key": "<api-key>"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

{
  "success": true,
  "documents": [
    {
      "path": "knowledge/vendors.md",
      "layer": "org",
      "version": "version-example",
      "content": "Treat approved staking rewards as revenue.",
      "frontmatter": null,
      "suppressed": false
    }
  ],
  "truncated": false,
  "next_cursor": null
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid path, query or request body.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient access to organization",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 30s.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "PROVIDER_ERROR",
    "message": "The memory service is temporarily unavailable.",
    "request_id": "req_example"
  }
}

Requires read:memory for documents or read:operational-rules for rules. For a document, Entendre reads the organization file first, then the firm file, then the default. layer shows which one was returned. If no file exists, the response is HTTP 200 with missing: true. With kind=rule, send rule_id instead of path. An unknown rule ID returns HTTP 404.

cURL

curl --request GET \
  --url 'https://api.entendre.finance/v1/memory/file?path=knowledge/vendors.md' \
  --header 'X-API-Key: <api-key>'

const response = await fetch('https://api.entendre.finance/v1/memory/file?path=knowledge/vendors.md', {
  method: 'GET',
  headers: {
    'X-API-Key': '<api-key>',
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.entendre.finance/v1/memory/file",
    params={
        "path": "knowledge/vendors.md"
    },
    headers={"X-API-Key": "<api-key>"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Authorizations

X-API-Key

string

header

required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

kind

enum<string>

default:document

document (the default) for a memory document, or rule for an operational rule.

Available options:

document,

rule

path

string

Document only, and required for documents. Relative file path, such as knowledge/vendors.md.

Minimum string length: 1

cursor

string

Document only. The next_cursor value from the previous page.

Maximum string length: 256

domain

enum<string>

Rule only. Limits the lookup to one rule domain.

Available options:

classification,

cash_application

rule_id

string

Rule only, and required for rules. Get it from List memory with kind=rule.

Required string length: 1 - 128

Response

The resolved document.

Option 1
Option 2

success

boolean

required

true when the request succeeded.

documents

object[]

required

Documents in the directory.

Show child attributes

truncated

boolean

required

Some documents were left out because the response was too large. Truncation does not show that a document is absent or that another page follows.

next_cursor

string | null

required

Pass as cursor with the same filters to continue. Null when the listing is complete.