holetron-lab/fleet-memory
1
0
Fork 0
Code Releases Packages Activity Actions

update openapi spec

Browse source
This commit is contained in:
Nicolò Boschi 2025-12-09 10:02:06 +01:00
parent bbfdcd36e4
commit 04b2fcf0b5
40 changed files with 2349 additions and 1477 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
hindsight-clients/python/hindsight_client_api/api/default_api.py
View file

@ -647,7 +647,7 @@ class DefaultApi:
) -> DeleteResponse:
"""Clear memory bank memories
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality and background) will be preserved.
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
:param bank_id: (required)
:type bank_id: str
@ -719,7 +719,7 @@ class DefaultApi:
) -> ApiResponse[DeleteResponse]:
"""Clear memory bank memories
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality and background) will be preserved.
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
:param bank_id: (required)
:type bank_id: str
@ -791,7 +791,7 @@ class DefaultApi:
) -> RESTResponseType:
"""Clear memory bank memories
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality and background) will be preserved.
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
:param bank_id: (required)
:type bank_id: str

2
hindsight-clients/python/hindsight_client_api/docs/DefaultApi.md
View file

@ -174,7 +174,7 @@ No authorization required
Clear memory bank memories
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality and background) will be preserved.
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
### Example

8
hindsight-clients/rust/Cargo.lock generated
View file

@ -998,9 +998,9 @@ dependencies = [
[[package]]
name = "reqwest"
version = "0.12.24"
version = "0.12.25"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9d0946410b9f7b082a427e4ef5c8ff541a88b357bc6c637c40db3a68ac70a36f"
checksum = "b6eff9328d40131d43bd911d42d79eb6a47312002a4daefc9e37f17e74a7701a"
dependencies = [
"base64",
"bytes",
@ -1542,9 +1542,9 @@ dependencies = [
[[package]]
name = "tower-http"
version = "0.6.7"
version = "0.6.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9cf146f99d442e8e68e585f5d798ccd3cad9a7835b917e09728880a862706456"
checksum = "d4e6559d53cc268e5031cd8429d05415bc4cb4aefc4aa5d6cc35fbf5b924a1f8"
dependencies = [
"bitflags",
"bytes",

2
hindsight-clients/typescript/generated/sdk.gen.ts
View file

@ -225,7 +225,7 @@ export const createOrUpdateBank = <ThrowOnError extends boolean = false>(options
/**
* Clear memory bank memories
*
* Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality and background) will be preserved.
* Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
*/
export const clearBankMemories = <ThrowOnError extends boolean = false>(options: Options<ClearBankMemoriesData, ThrowOnError>) => (options.client ?? client).delete<ClearBankMemoriesResponses, ClearBankMemoriesErrors, ThrowOnError>({ url: '/v1/default/banks/{bank_id}/memories', ...options });

18
hindsight-docs/docs/api-reference/endpoints/add-bank-background.api.mdx
View file

@ -1,13 +1,13 @@
---
id: add-bank-background
title: "Add/merge memory bank background"
description: "Add new background information or merge with existing. LLM intelligently resolves conflicts, normalizes to first person, and optionally infers personality traits."
description: "Add new background information or merge with existing. LLM intelligently resolves conflicts, normalizes to first person, and optionally infers disposition traits."
sidebar_label: "Add/merge memory bank background"
hide_title: true
hide_table_of_contents: true
api: eJzVWN9v4zYS/lcG7MtuoNhOrtcWenO2SWsguxts3L4kwWIijWU2FKmSlB2f4f/9MKRs03Kyi8vdy+UlsjicH98MvxlqLTxWTuR3YlyR9vARNVZUk/biIRMlucLKxkujRS7GZQmalvCIxVNlTatLkHpmbI0sAMZCTbYiWEo/B3qWzktdDeD6+iNI7UkpySbUCiw5oxbkoDB6pmThXQaa9Sj5L3LgDcykdR4ass7oDFCXYIIXqNSKjZJ13Soq6VfgLUrvBiITpiEb/JmUIhdYll+RrX7dOy0y0aDFmjxZjnwtNNbEwkFQsoDkeBv0c5EJS3+30lIpcm9byoQr5lSjyNfCrxre57yVuhKZ8NIrfhGhnJRis3mI+8n5C1OueFNfXWG0Z7jztcCmUbII3g//coz5OrHWWI7NS3L8K9n2mhsfOpF+Hj+9nkNvAMtyl0qxyUTblOjpa4J2YvPRGEWoE6N/BHG4ScT79iczCKHHRMKFrOBKLuiFhMLMmhr8nKI7Zer2u5Jm2CqfB2Xvg5XwIgK72WRbJ83jX1T4g0ze7fB7SNJWlhc7/V9i1o6c795DbUpSMDOWAZO6GrKHUlevIMulSc9YN2wpyZ6YwBIdPBqrQWqY0jM68TLoMaoNB2bJNUa7WAnnoxH/O3Tzti0Kcm7WKvjSCYs311pydr5RbnvsuGx69YJ69XkWDtuhatOQ1uRcoli39SNZkYkan2Xd1iI/y0QtdXwe7Q1+3u7t52i7wOVMzw1ZSbogeDc6PXvPvhVGu0KS9tK07q3WPxwp6btxJLH3gJ69xQVZJyPy/6nxy3R/3266uDeJlSXCR0VvDXh8oOCoOaSre6uaWmu8LKSr32LzU7L9mMZ2a3t7jxLdV+ct6crP32LxQqKD262Cvs3fzRKct0ZXanXAV1LPVMtV5sA0UkujdyB8h4jMvoqP67JXKf0sHuLbjz6htoSOp4FZjyK7OSbfR3RUgtF7hg6k16OyXl2NBj8fZSG8e+HQjQY/9Y/CaPDPXtGMBv/IEpoYDX7ZbLIkr0qJzcP3QE4Y7OElxko4sk/3cSHh+4TgI033AEnZ8iV6H8AEsAYEZ2Z+iZaAdCU1kY2T09kIVoTWgZkl7MVG+pzaR/6XF5D/6b9B/sdD5H/edP3nx/Pz45bzJypZxjHi0lpj395vSvIoFT9JT7U7FlCmOFjdd5fD5pQUCk+gFVmulV2poLW4SjrYtYkOMpHUrvpWs/tIzmEckKLI66IBDJjy6vfKlOOKpju5pFj38EZ0Xw/j1wjfS8a2Ir9PpzdHCmNua/Jzw6XbmDD+hCk4F0Ns5HBxNgxDshuut8PyZngwWXNqv+wH3sv/wcjD0/jMBIQP5uuPVBu7gvHN5OjU3usxeKobY1GdOqpRe1lAHTe4lfNUh6M8nkCMB/wcPThvLLkMLHkracGPfPWwhI753CzIRiWS3OBe3+sffoArQt9acvzzBE5OLtAX861vt95YrOjkJA+PBHWrvGwU7dQAzWYyHE61iscfW294ZixghoWHcEgLjivqv91Gc0toizmrvpLBSUUL1H6vuXU8jmp2DxUo1FWLFcHfLTOKi9qu2ASXJlxJ5YkrNzgbdAMW1jgHS2NVGbxhQAL20SO3vZp1Dc8RX6w8qVXUPp1L/QSXumyM1J4V/0aar2cEoRqefYsKULsl3+d27SaakCUzll8FE9ugot7fLDZz+FO6lm+MoYRZ+UR7ClgtaJvrKkguUsmo4ldTtHzLhanF4qkLOzxHe+EavNVSdsIuZqhtHFkPrm0aY31XB2NbzKWngouBX03ntK201pHL7/UpI9IVJVxL/eTY5gejNRVJ2kIlclcolHHEJ8TLmuL2XfKPtm+LPFyQnaylQpugxpsvI5zfsVyHPqHDpcthzc3JS79TcttYQr7vwJiBPsC+u+BD11UwtssOw+5MobrX0P11DQKL0CC6S/j25ATomOSULIg7815k3GAxJzgfjJg2rBK5mHvfuHw4XC6XAwzLA2OrYbfXDa8nHy4/3V6eng9Gg7mvFSvedT5xNhgNRuHSYpyvUae2ynIYv2rEqjwguwPSSRnu/+JLSdcb+BgOG4UytL0A57oj/TuBjRSZWJyFyZNPgMhEnnwnOZyr5twx8juxXvNZ/sOqzYZfM+OsRH73kIkFWskTS+jVpXT8XIp8hsrRN/B896Vrku/hNce3vVBzJ1ygavmXyMQTrdJPO6H9zwlLssGHuNx9KTkNTXq//Whm4Xki7hgXBTX+m7IPSS+9+Xw7Zbi6b0A8TIpcWFzyAIDL6GpMXBhowru12JK2yEXUyX//Bl8n5ck=
api: eJzVV0tv2zgQ/isDnhJA9SPdvQjoIW0D1ED6QJLuJTAKWhxZbChSJSk/1tB/Xwwp2/Qj6SLYy/piWRzOfPxm5uN4wwS6wsrGS6NZzq6FAI1LmPHiaW5NqwVIXRpbczIAY6FGO0dYSl8BrqTzUs8HcHv7GaT2qJSco/ZqDRadUQt0UBhdKll4l4EmP0r+jQ68gVJa56FB64zOgGsBJqDgSq0pKFoHQrrGOBlie8uldwOWMdOgDXgmguWMC/FjxvXTjz1mlrGGW16jR+tY/rhhmtfIchbsJK1LOm3DfcUyZvFXKy0KlnvbYsZcUWHNWb5hft3QNuet1HOWMS+9ohfvuX6CiWBdN43b0fn3Rqxpz7G3wmiP2tMSbxoliwB9+NMR4ZskWGPpYF6io1/JtudQfOhNsqMkfnk+gd4AF2KXR9ZlrG0E9/gjoTqJOTNGIddJ0O/BHD4m5sfxJyWEo8csnkkilNbU4CuMKESK9kJgyVvl8+DjMjgPLyKfXZdtsZnZTyz8Qf4ed7RN94ivhXi/838Xk3WCuX8PtRGooDSWeJJ6PiSEUs+fIZTKEVe8bihSkjQ2gSV3MDNWg9TwgCvu2Hmu46k6OphF1xjtYgFcjUb0dQjzvi0KdK5sFdz1xuzVJZY0zIu1vrPqMnZUJlyvv5ahww5duydsvCykqxPXpBBztCxjNV/Juq1Z/mfGaqnj83gf836//ThRn8wSeu9cwcJRmQQVgovxu+1zBn++2xldEm4lPVquXgvodr/9HKDeu1pTg5FX21j0B513MX5XKlzJmUJC1+8I2LAmIVq/CthNv/ccqrotKgJUGO2kQAtYm6iwECpm5QmVQM+LCgWhikjQy+KS/a7TXJojlfKzPU/Sg4lcPAQJOAH88VQlfMUDh6pFXSBUdCSsjZXogFukLq1RhKtjxzmKo5bckfv2sAjeZgdF+rbrsh39ulWKddPfMZD0z/RcvyQdeiw2cSFRm0ReokgcHSPt1XPiMoAJ8Bo4OFP6JbGDei41oo139XgEa+TWgSkBVw1aSZxSkKOO/vd8Rc364+rqVKb+4kqKWPc31hr7eo2i6pSKnqTH2p0aKFMcrO4V6VDQkvRuu6ub7hPMreXrRPVuTQRI/Vm7+UsC+Rmd4/EujSbPmwYy4IFWf1dcdK4YurdLSmxPb2T3+WN8jPSdC7Y1+fTw8O3EYcxtjb4yVHCNCVdmmJdyNlyMh/2lPKSJyg03/WDVDQ+GMEru3X46uvkPLkqa3EoTON7il1o4Oa880Eng+tvkVAz7hdBpO/u+KHkRirKfED+TwKzhfu081vHiKJB6eG9y3ZBewtVgRECtYjmrvG9cPhwul8sBD8sDY+fDfq8b3k4+3Hy5v3lzNRgNKl8rcrxA6yK88WA0GNErornmOo0lxDBO3HUERkTDAckHR02Z/V/M8n1V0mU0bBSXoeECqZu+3B7ZYpxMgVkY4qlG8v00f6jEFVVr/sg2mxl3+N2qrqPXv1q0a5Y/TjO24FbyGZXP44YEkJ4Fy0uuHL7A6MVd36CX8Bz0bR9q6sIFVy39Yhl7wnXy/yMoT4VcoA0Q4mo/z78J+rDffSKXJGVxx3VRYONftJ0mbfzt6/0DsdX/U6Hbh+XM8iVpD19GpDFzQUvDuw1TXM9bUricRZ/0+QfL3viK
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -22,13 +22,13 @@ import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Add/merge agent background"}
children={"Add/merge memory bank background"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/memory banks/{agent_id}/background"}
path={"/v1/default/banks/{bank_id}/background"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
Add new background information or merge with existing. LLM intelligently resolves conflicts, normalizes to first person, and optionally infers personality traits.
Add new background information or merge with existing. LLM intelligently resolves conflicts, normalizes to first person, and optionally infers disposition traits.
<Heading
id={"request"}
@ -47,14 +47,14 @@ Add new background information or merge with existing. LLM intelligently resolve
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"content":{"type":"string","title":"Content","description":"New background information to add or merge"},"update_personality":{"type":"boolean","title":"Update Personality","description":"If true, infer Big Five personality traits from the merged background (default: true)","default":true}},"type":"object","required":["content"],"title":"AddBackgroundRequest","description":"Request model for adding/merging background information.","example":{"content":"I was born in Texas","update_personality":true}}}}}}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"content":{"type":"string","title":"Content","description":"New background information to add or merge"},"update_disposition":{"type":"boolean","title":"Update Disposition","description":"If true, infer disposition traits from the merged background (default: true)","default":true}},"type":"object","required":["content"],"title":"AddBackgroundRequest","description":"Request model for adding/merging background information.","example":{"content":"I was born in Texas","update_disposition":true}}}}}}
>
</RequestSchema>
@ -62,7 +62,7 @@ Add new background information or merge with existing. LLM intelligently resolve
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"background":{"type":"string","title":"Background"},"personality":{"anyOf":[{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}},{"type":"null"}]}},"type":"object","required":["background"],"title":"BackgroundResponse","description":"Response model for background update.","example":{"background":"I was born in Texas. I am a software engineer with 10 years of experience.","personality":{"agreeableness":0.8,"bias_strength":0.6,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.4,"openness":0.7}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"background":{"type":"string","title":"Background"},"disposition":{"anyOf":[{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}},{"type":"null"}]}},"type":"object","required":["background"],"title":"BackgroundResponse","description":"Response model for background update.","example":{"background":"I was born in Texas. I am a software engineer with 10 years of experience.","disposition":{"empathy":3,"literalism":3,"skepticism":3}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

90
hindsight-docs/docs/api-reference/endpoints/batch-put-async.api.mdx
View file

@ -1,90 +0,0 @@
---
id: batch-put-async
title: "Store multiple memories asynchronously"
description: "Store multiple memory items in batch asynchronously using the task backend."
sidebar_label: "Store multiple memories asynchronously"
hide_title: true
hide_table_of_contents: true
api: eJztWVtv27gS/isD7sNpA8V23D0vAvbBTdMeA+02m3j34aRBMZbGFjcUqSUpu17D//1gSMqWc2tRnJcFmidLHA5nvrlwPmUrPC6dyG/EB6qN3cDHhix6abQTt5koyRVWNvwscnHtjSWoW+VlowjquEN6qh1IDXP0RQXoNrqorNGmdWoDrZN6Cb4i8OjuYI7FHely8El/0gAAs0o6IF02RmoPlnxrtQNZ11RK9KQ2gAtPFv5qqe0rymAtfWVaD2uUnlcWxkJh6kYRWzvo1BNg4VtU0FhTkAvWVNg0pIPNrI9tWlrT9sx6S+hbSy6Pj6cw7SwCS64x2hG80EafzpUp7qRevuwEX++V9U9cSYz+sx/UyV4sFrKQpH2C7rChk5i03tToZQELLDzQF2+xYP9gYU0Nmq1EBQr1ssXlQbH20m/AUmGWWgZ51CUoqe96yt+Yoq35dFbKCwFTwP2ZbePIenixrkhDmaQ/yxKkY1tXsqRy7/iM6sawMXySoxo1q9gfeYiH2zhP9eEYVGqTcD4bwG8MkEtxCaC0PkAXJcYDuHokSYLhri0Yvl9mtqUsIl2Gh7j11QAuI8CU0rWLVN4B6wLMLoMlaS4DckD1nMpS6qXLoLAU3rFTrnPpV+Mph+niKYACHqgsYbkB+iId62f3jCr3e4KQ9K6rqVbzw1oqBXOCkhR5KmFOCy7AYAaHS9MajCYHL1Kk5lThShr7ciAyYbpKnpYiFwHMz03rP4cCFZlo0GJNniyX/1ZorEnkApfRBZEJyTXfoK9EJiz91UpLpcg9oytcUVGNIt8Kv2l4n/NW6qXIhJde8YsJK4JpKXa727ifnH9tyg1vuq+uMNqT9ryETaNkEQwf/um472x7pzWW3fKSHD+F1nP043i9p/YpM8+TyC4TtGLXS/QU7NCbj4uAzP2tC2Nr9CIXLHrqZU1il+3FdKuUYJe7Ey5YLbxhtbvk6Rf/3AnPKTtP23e7rJMx8z+p8Ecxutl73tsaG/zUUy0eNHapl8cNPbTTfQFyOtEX5OZ6BKuYKFnwPs2KqARX0b8crI0N7YTbTkjSD++hNiUp0fNfeMIaaiIfUe2jL8aj8c+no7PTs3/Pzkb5q1E+Gv237zNai5teFKch/rtM9IrweyHet8WQu8/DHPOut/k1Q3bZ+quY7w+QTu8jHMcg76/Be2gfucT4rci6UB+fz8avuE5j8t88DAwHwgF6eGfMUtER/LwWcDhsem3msGbPKxnityHnyZYB6WfCM0rhud3xHwMUb8hQguPRKDhxnG+xUy9aBVdJWHx3E0htv1fkc2MUoe7lRzqQM6Qm53BJz/WED0lklx3a4Td1uv9//qXofi5Me9THpPa0JHu/BOA8yO0yEa+/Z0H5LYp8Lcc7fA/QZUe3RM++/bGPVMSEr51etO/XRZqqDoUR7qmvl8chQqJ1ZGNJfFvNdKiOe1kR7d1PHWmMSJX6yGh38Lm7Gbt05MdUET+Pxw+L4A9Usgw2wYW1xn5/BZTkUapn7kFliqPVb0jLLsF2t0933fcmGhjKyi2/saSiyNOiAQyY8erXUpP9ikcnuV7eHeCN6D7txpsI32OHdSL/mc0uHyiMsa3JV4azrDGh34eBKRdDbORwdTYM6emG2y5Nd8Nwy0pyw24Q4/BeHeaji39k6+dxcWFCXI/aYqKVk8vpg5r/pCfgE2s43TOGNIQklsB1N5lCRBF8hR4cs1CXMVm0klb8k6dnS+iMdmBWZKHDOBC6n37a8zl+PIGTk1jkyTamtbikk5McHmO4kllAx9Q6roFPEbOo/7rz5prQFhWrfiuDkYpWqP1Bc+TH94kctx1ejtre8hFcEPBWKk9cL8HYoBuwsMaFoUuVHX8JeEG0KOFjGqn5CRzx5M+0KWqfVVLfwUXqrqz4XWI/kFKmDazOrck6mKOjMkx24QhZUuSafETnVNT7zmJTwR/Stajk3yFrWflUewpYrfYD5zJIrvqSUcX+KpwlhsoKwu94HmrGKmnpisXFCCVK5NqmMdanPJjYopKeCk4GftXjo60LdP+UEemo7HsmenzmudGail7YQiYikzFlHIUvCbKmuH0f/AfbuyRnygtO1lKh7aHGmxN1/8rJaeIOPNJhTRCisFdy3TDd5MSaMNBH2Csll4n0h24SL9uEYaopVJHb8l/qHFiEaymxxK5yAnTcWrnn8L1+EJk0WFQE48FIZKK1SuSi8r5x+XC4Xq8HGJYHxi6Haa8bvp+eX/x6fXE6HowGla8VK2YbY7s4G4wGI37FjbZG3TvrqbI9/hZ1vwH1+9+PT1s/Pm39+LT1T/m0lcY0vpuGjUIZJtDQY7Zp/roR2EiRidVZx1aYwOQ93tI1CV4Pg9htJioe4fIbsd3yNfe7Vbsdv+bLeCPym9tMrNBKnPN8c7MVpXT8uxT5ApWjZ9rLi6s0tb6Ep8zvhlPNfWqFquUnkYk72vQ/y4VRqyIsyQYb4nL6inUapubD9gckgoe+uGNSFNT4Z2Vve8Pt5cfrmcjEPH2/Y5YmcmFxzRM5rqOppon/OOAPfPxuK7rqFbmIOvnvf5AXhWg=
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Store multiple memories asynchronously"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/memory banks/{agent_id}/memories/async"}
context={"endpoint"}
>
</MethodEndpoint>
Store multiple memory items in batch asynchronously using the task backend.
This endpoint returns immediately after queuing the task, without waiting for completion.
The actual processing happens in the background.
Features:
- Immediate response (non-blocking)
- Background processing via task queue
- Efficient batch processing
- Automatic fact extraction from natural language
- Entity recognition and linking
- Document tracking with automatic upsert (when document_id is provided)
- Temporal and semantic linking
The system automatically:
1. Queues the batch put task
2. Returns immediately with success=True, queued=True
3. Processes in background: extracts facts, generates embeddings, creates links
Note: If document_id is provided and already exists, the old document and its memory units will be deleted before creating new ones (upsert behavior).
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"content":{"type":"string","title":"Content"},"event_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Event Date"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"}},"type":"object","required":["content"],"title":"MemoryItem","description":"Single memory item for batch put.","example":{"content":"Alice mentioned she's working on a new ML model","context":"team meeting","event_date":"2024-01-15T10:30:00Z"}},"type":"array","title":"Items"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"}},"type":"object","required":["items"],"title":"BatchPutRequest","description":"Request model for batch put endpoint.","example":{"document_id":"conversation_123","items":[{"content":"Alice works at Google","context":"work"},{"content":"Bob went hiking yesterday","event_date":"2024-01-15T10:00:00Z"}]}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"agent_id":{"type":"string","title":"bank ID"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"},"items_count":{"type":"integer","title":"Items Count"},"queued":{"type":"boolean","title":"Queued"}},"type":"object","required":["success","message","agent_id","items_count","queued"],"title":"BatchPutAsyncResponse","description":"Response model for async batch put endpoint.","example":{"agent_id":"user123","document_id":"conversation_123","items_count":2,"message":"Batch put task queued for background processing","queued":true,"success":true}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

87
hindsight-docs/docs/api-reference/endpoints/batch-put-memories.api.mdx
View file

@ -1,87 +0,0 @@
---
id: batch-put-memories
title: "Store multiple memories"
description: "Store multiple memory items in batch with automatic fact extraction."
sidebar_label: "Store multiple memories"
hide_title: true
hide_table_of_contents: true
api: eJztWFFz2zgO/isY7sO1GcV23O6L3tw07Xmm3XYa3z5cmsnAEixxS5FakrLr8/i/34CkbDlp0l7nXu5m/WSJIEB8+AAC2gmPlRP5jXhPjbFb+NCSRS+NduI2EyW5wsqWn0Uurr2xBE2nvGwVQRN3SE+NA6lhib6oYSN9Ddh506CXBayw8EBfvcWCtYw+688aAOANoe8suTw+nsPVaiULSdonPa01BTknddVLzB5TCitrGtCsEBUo1FWHFR0Uay/9FiwVptIyyKMuQUn9ZaD8tSm6hq2zUl6470jXOrIenm1q0lAm6TtZgnR81rUsqXzea1tQ0xo+DFty1KBmFQeTUWxRE7it89QczaBS2wTJxQiuoovuqGIVHoO/viYojPakfdwwHcFb0hw+ckDNkspS6srFxRcjeE1l1ypZhHUnG6nQRoVR5OUILi2FVZ/Onx0sZ8EViliyI2nTryNYMGLugAk05LFEj72fvxlPOcxXj6EWNKOyhOUW6Kt03mXBO6PKo1YWkt71rOs0P2ykUrAkKEmRpxKWtGKKFuwGx1DTBowmB89S+JZU41oa+3wkMmF6rs9LkYtAu7u283fBhCQnMtGixYY8Wc6RndDYkMgFVtELkQnJidGir0UmLP3ZSUulyL3tKBOuqKlBke+E37a8z3krdSUy4aVX/GLGimBeiv3+Nu4n51+Zcsub7qtLweYlbGMgpdHjPxwn525grbXsmWcP8p0I+Xny53R9oPaxY14mkX0maM2ul+gpnENvP6wCMve3roxt0ItcsOi5lw2JfXYQ051Sgl3uLVyxWnjNavfJ06/+KQtPKbtM2/f7rJcxyz+o8Ccxujl4Ptgaq+DcUyMeVD+pq9OqBytj+2rVeWYUfcWmVXQCq5gpWfA+zYqoBFfT3xxsjA1lhstR4On7d9CYkpQY+C88YQMNkY+oDtEX08n05fnk4vzi18XFJH8xySeTfw59RmtxO4jiPMR/n4lBHv4sxIdyGbj7NMyRd4PNrxiyj53/FPn+AOn0PsJxCjKQLlsj9X20T1xi/NZkXciPu4vpC87TSP6bh4HhQDhAD2+NqRSdwM9rAYfjpldmCRv2vJYhfltynmwZkH4iPJMUnts9/xgg1xrtYgpOJ5PgxCnfuoIvwFWn4FMSFj9dBFxUNkjypTGKUA/4kQwyQxpyDit6qia8TyL77FgOf6jS/ff5l6J7V5jupI5J7akiez8F4DLIfY+2PWRHNLKTwj8w+U1uH0J2n9xx4T9h9xFg0TmykdE/RvkelOkgqANqqS047upKmJ70cyI7UoZvn8Tal9PpQ6L+jkqWwTBcWWvsz7O0JI9SPXFXKVOcrP4AdXoS7G8fr4zvTDxgoL6rfpD2UeRx0QAGLHj1e1xjv6LpJDdg1BHeiO7jbryO8H3LWC/y98Xi4wOFMbYN+dowlVoTanJoanIxxlaO1xfjwEE33vVc3I8HbRIH9tOxe7n6nyzM3MytTIjoSdFKk9Hs4/xBMn/Ws0OvfH5o0lMipd6eM3w2h4gf+Bp9TDmXgSVvJa35L7e3ltAZ7cCsyUKPbpiYfvnlMDDx4xmcnYVC05+NJzOs6Owsh28NaZIHgn6+UtvvzGhR/3XvzTWhLWpW/UaGQypaY2jzk+bOhVb73vgFf3bEy1HbGzbBqQBvpPLEmRIOG3QDFta40BKpMk4kWcQL4okSPqaVmp/AEfflntQ2al/UUn+Bq1Q8WXE/CEGiTBdmMbch62CJjsrQdwUTskxTDZvonYp631psa/hdug6V/FdgLSufa08Bq/WhHayC5HooGVUcLqpFmitZQfgf7aFmrJKWPllcjFCaWVzXtsb6xIOZLWrpqWAy8KvBFNm5ME+fMyL9APqORzW2eWm0pmIQtsBE5GlJGUc8wHOXHrcfgv9ge09yDFdHGiKPqPHmNHB/x3Lqh8Og57ChOFselFy3PA8ysWYM9An2SskqjeqhmsRbNGGYcgpVHD75lyoHFuFCSjNcnzkBOi6qXHP4wj6KzFosaoLpaCIy0VklclF737p8PN5sNiMMyyNjq3Ha68bv5pdXv11fnU9Hk1HtG8WK+YyxXFyMJqMJv+IS26Ae2Hokbe9XnGHB++tzzF+fY/6fPseknoXL9bhVKEM7FtJul5qRG4GtFJlYX/S9OCdIPujKD3lzm4ma+5j8Rux2XPH/YdV+z6/5XtqK/OY2E2u0Epd81d/sRCkd/y9FvkLl6InEe/YptW7P4bFj9x2a5u5jjarjJ5GJL7Qdfj8KXUdNWJINZ4jL6XPLeWgdj9sfdNLc/8Qds6Kg1j8pezvo8D5+uF6ITCzThyaeREQuLG64LcVNPKpp42dg/hLF73aiT2WRi6iTf/8GNVi39g==
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Store multiple memories"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/memory banks/{agent_id}/memories"}
context={"endpoint"}
>
</MethodEndpoint>
Store multiple memory items in batch with automatic fact extraction.
Features:
- Efficient batch processing
- Automatic fact extraction from natural language
- Entity recognition and linking
- Document tracking with automatic upsert (when document_id is provided)
- Temporal and semantic linking
The system automatically:
1. Extracts semantic facts from the content
2. Generates embeddings
3. Deduplicates similar facts
4. Creates temporal, semantic, and entity links
5. Tracks document metadata
Note: If document_id is provided and already exists, the old document and its memory units will be deleted before creating new ones (upsert behavior).
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"content":{"type":"string","title":"Content"},"event_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Event Date"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"}},"type":"object","required":["content"],"title":"MemoryItem","description":"Single memory item for batch put.","example":{"content":"Alice mentioned she's working on a new ML model","context":"team meeting","event_date":"2024-01-15T10:30:00Z"}},"type":"array","title":"Items"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"}},"type":"object","required":["items"],"title":"BatchPutRequest","description":"Request model for batch put endpoint.","example":{"document_id":"conversation_123","items":[{"content":"Alice works at Google","context":"work"},{"content":"Bob went hiking yesterday","event_date":"2024-01-15T10:00:00Z"}]}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"agent_id":{"type":"string","title":"bank ID"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"},"items_count":{"type":"integer","title":"Items Count"}},"type":"object","required":["success","message","agent_id","items_count"],"title":"BatchPutResponse","description":"Response model for batch put endpoint.","example":{"agent_id":"user123","document_id":"conversation_123","items_count":2,"message":"Successfully stored 2 memory items","success":true}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

8
hindsight-docs/docs/api-reference/endpoints/cancel-operation.api.mdx
View file

@ -5,9 +5,9 @@ description: "Cancel a pending async operation by removing it from the queue"
sidebar_label: "Cancel a pending async operation"
hide_title: true
hide_table_of_contents: true
api: eJy9VktvGzcQ/ivE5NIaG8kxetqbGsupAacJYjUX2wjG3JGWMZdkyFk5W2H/ezHc1SuuExQtqou45Mw3Mx/nwQ0wrhKUN/CWGh879S5QRDbeJbgroKKkownyDSW8RqfJKlSBXGXcSmHqnFZ+q6LuOxWp8Ws5M6yW0TeKa1JfWmoJCthJXlZQgs5wn3abUEDAiA0xRXFpAw4bghJwRY4/mQoKMOJHQK6hgEhfWhOpgpJjSwUkXVODUG6AuyB6iaNxKyiADVvZmAmQuqyg74sd+s7+f2FhR99g5U4wUvAuURK1s9NT+Tum9brVmlJatlZ9GIWhAO0dk2MRxxCs0Rl2+jmJzmbvSt/3fQG/nJ09Bf6I1lSDN/MYffwHqBCi8MJm8LsiRmNlZZia9FTAen10iq57t8x3eMyU8D7uGMe0ogj9XV9s9zBG7A7ovPKDg9AX0KTV95h/SynhimAH9rxoJkMt5LTf2/b3n0nz0a3f5LgG06Pc3R5mT+/A7vNhnA/0/Z2xrchvi8X7J4DD3TbEtZeCqcgSUy4TrqGEKQYzXb+a5vpI0822TvrpLqfTdHOY331O8KXP7BwVxVj+s/eX8G3Z37qZYmqCj2hfJmrQsdGqGRRSl5gatfRRzS7V4IniGlkl9pFSoSJxNLSWJbpKRcLkXVJ+TXEAMZQmt+7WvXihLgi5jZTk80SdnPyKrOutb9fsI67o5KTMS1JNa9kESzsYRcul0YYc2049Gq4VtuwbFH+XqFnRV46oJa4B/3obzTVh1LVAX5jspKU1Ot4jt0mamhP30CqLbtXiKnc2OR7QLsSEpJW6MJZJsi47m7EV6uhTUo8+2ip7I4Rk7gePRn58ME6+VCLphky2G9AXtXEPau6q4I1jAX5DTq6WVK7qr9yiVejSI8Wk7jFRpbwbTZiKHBvusoltUAPum4ihVh9NatGaP3OmCPilY8pcrWl716ssuT6UHCDOvW4bMbOIqB/GsPN6sIdOuBpRqlE4DTfUhkSRVWpD8JHHPJhFXRsmLckgW4uatpnWJkrlrXspjIxJqa6Me0hi87V3jvTBteVMxEhKW59IGafYNDSo7y7/ifo2ydHaTiXTGIvxgDVRng90/sCyxCntV4ZgwoZUvoUdyHWIhHmSzoToI+6tNfnmOOKaYkKba2zkcKwptLdOjb+xuaPOzX2cbdvKydRJg7JGk8yXvcgsoK5JnU1OoYA2WiihZg6pnE4fHx8nmI8nPq6mo26aXl2+nv9+PX95Njmd1NxYARYfh3bxanI6OZWt4BM36A5s/egB8W3r2ezn1b9/fIydVwplGiyaPFRywJuxod4ABgMFrF9BMTw6EhRQHjw/9n1VDo5eDncF1D6xoGw2Un1/RNv3si09ooPy5q6ANUaD99J2bzZQmSTrCsol2kTfif2nD+NI+lk9F8h28jiZO2u0rXxBAQ/UHb6gZP7+j3aPGMqDviasKOb4B5GZ1hT4QPnJu0ReUbsZeD6/mi/m0Pd/AQeDus0=
api: eJy9VE1v2zAM/SsCTxugxWmwk29dG2AB2rVYs12CoFBkOlYrS64kpzMM/fdBsmMnzdph2LBTHPLpkXz8aCFDy42onNAKUrhgiqMkjFSoMqG2hNlGcaIrNCxAyKYhBku9Cz7hSG50SVyB5KnGGoHCgFxkkAKPdPeDEShUzLASHRoL6aoFxUqEFDZMPd6LDCiIkEbFXAEUDD7VwmAGqTM1UrC8wJJB2oJrqvDMOiPUFig44WQwfGLqkSwy8J4O3EP0fxHgZlAiRlkHDltpZdGGZ7PpNPwci3pXc47W5rUkX3swUOBaOVQuwFlVScEjbfJgw5t2TMV77yl8nM1Oib8zKbIum7kx2vwBK1Qm6OJEl3eGjgkZvoTD0p4CpOZHXqaamzx28FipoHtvEcrhFg34tad7GzOGNQdyXukuQfAUSrt9S/lrtJZtEQay16FRDLIMXj/G1psH5O6o66tYVxe6x61HmlHeTt3Xy7js5PtVsD3k83J5e0LY9bZEV+iwLhlKdBiXxBWQQrI7SzLMWS1dEjbEJm2/KD4Zptom7eGE+zjiuY767GMLlVmxLRwJWZDz2wXQF6O0d5BcGzLg+4FiPA5Uv0/XWGrTkLvGOiyDKFJwDDM9Qs4rxgsks8kUKNRGQgqFc5VNk+T5+XnConuizTbp39rkanEx/3I3/zCbTCeFK2Ug3qGxXXpnk+lkGkyVtq5k6iDW707Wy1LbcUf+/tz13Xb4wyWVZCIOciy47Zu4gt1ZTCG2EWg8dRYopOPNG3sZ7Ef3ak2h0NYFnrbdMIvfjPQ+mJ9qNA2kqzWFHTOCbUKrVy1kwobvDNKcSYtvVP/ua78I78lrpeznXYVp3zFZh39A4RGbg6sdlv4/hj0SKF6XAlmGJpbfQc45x8odPD45huF0D4t3Ob+aL+fg/U/oHmg6
sidebar_class_name: "delete api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"delete"}
path={"/api/v1/memory banks/{agent_id}/operations/{operation_id}"}
path={"/v1/default/banks/{bank_id}/operations/{operation_id}"}
context={"endpoint"}
>
@ -47,7 +47,7 @@ Cancel a pending async operation by removing it from the queue
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"operation_id","in":"path","required":true,"schema":{"type":"string","title":"Operation Id"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"operation_id","in":"path","required":true,"schema":{"type":"string","title":"Operation Id"}}]}
>
</ParamsDetails>

16
hindsight-docs/docs/api-reference/endpoints/clear-bank-memories.api.mdx
View file

@ -1,13 +1,13 @@
---
id: clear-bank-memories
title: "Clear memory bank memories"
description: "Delete memory units for a memory bank. Optionally filter by fact_type (world, agent, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The memory bank profile (personality and background) will be preserved."
description: "Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved."
sidebar_label: "Clear memory bank memories"
hide_title: true
hide_table_of_contents: true
api: eJzlVlFz2zYM/is49qXNqXaa25PfvMbpcteuvSbrS5PrIRQssaFIlaCcej7/9x1ISZGXZu26x/kligR8AL8PBLBTEStWi49qWZGL8AYdVtSQi+q6UCWxDqaNxju1UKdkKRI01Piwhc6ZyLD2AdABivMM3iZTtHYLa2MjBbjZwhp1/BS3LcHTOx9sWWTrAnxrnPHuGUQPZcb2zm6BW9JmbTSIE8/gsjYMhgGhJI6h09FsCHxLASUcxBojaHTOR7gh6FzpHYkb5UjQBr82luBpS4ElPxO3gK6EG9S3VfCdK5/BnbFW3NtATGFD5UwVagxyXqqF0pYwfEqYnxILhlgVqsWADUUKwuNOOWxILVQ2M6UqlBH2Woy1KlSgL50JVKpFDB0VinVNDarFTslp1UJxDMZVqlDRRCsvsjDnpdrvixF9JHWA/9JR2B7gr9HyQQB027frlOJhKIHt37jOWrV/oPyga9IyyTLo+4ikk/TPxOVS4Pf/HVZSC8Std0wsZzo5PpY/h7gXndbEvO4svO+NVaG0d1HqWphoW2t0Enb+mcVnN+GpDSJ7NDkCZ7CJQjfeW0I3OWMfUE7YEDNW9E+CvulN9vtisPE3n0nHA/k+jpHvQa/vQfJlnBzvkILhAzS+JJuu6XDFhpJmKXD6ik1rU7pj5uLsu6CpdymBR0Kt1NhIiZTwXn6F+uXk5KEQH9CaMl/SVQg+/LwKJUU0Vp5MpIYfGlivD77+QLEbF6mioPbX90JgCLidaPXa5wSTtFz9kKwD2OOmiYz+UnynCORcOXRvN6mBe3ozu48f4zTT961gg8lvl5fvHgBmbRuKtZcGmOshtbxYq4WaY2vmmxfzdE15vht63n4+aY/GrX0i46CfvclTZPnu/EHtXrklRGpaH9A+Z2rQRaOHscNbjtSkgl6e5/7AeQJw9IG4gEAxGNrIo/T4QMjeMfgNBRjSml25K/fkCZwRxi4Qy79HcHT0K0ZdD7ldRB+woqOjRXokaDobTWtphAFar4025KLdwp2JNWAXfYOSb+pp9DUG1HKujH8xnOaCMOhaoM9MStLSBl28R+7YuAqcpIcWLLqqw4pA2ryRfAVtbK1wltqmcVVKNmED6uCZIXXSlA33/RRyRj0/fW9lYJJBFsluM/plbdwtrFzZeuOiAL8iJ72DIF3ir7FDC+j4jgLDDTKV4PtVAExJLg5jdjhUxn0VsK3hg+EOrfkzVZuAn7tIiavNuGJUyXIztcwQp153sqPAZUB92x87Ped4aYkZUMremLNCXcsUInDXtj7Evg6WQdcmkpZikFeyO/SV1jHx4so9F0b6ooTXxt2yxHzpnSM9kS1VIgYCbT0TGAfRNJTdR/EfuA9FnjYnNo2xGCasifMq0/mdyHLOvBIRMDYESYUR5KINhKUU1lKIPuDeWpOUiwE3FBjz0Og57O8U2isH/a/v5ahTL+/XkuHmJOqkH1mjSebTvcmyRV0TnMyOVaG6YNVC1TG2vJjP7+7uZpg+z3yo5r0vz1+fv1z9frF6fjI7ntWxsQIsOeZ28WJ2PDuWV63n2KCbxHopC1tfkZOOdNBudvcj6f+44fbjQK7zvLVo0qRLsuz6Lv9RYWtUoTYvVJG3WuFwMdlvR2qvC1V7juKz20lH+CPY/V5e5/VUxnFpGG/sZEF9VI2f2jq/dZxb2v5tZd6g7cQuLZQbDEZS+pfpPX3fj+ln8FjgYRq77TTmkNDIYFpAasKSQsohf15qTW2cOD7YlyT5cTafrl6vLldqv/8LyLPVmQ==
api: eJzlVU1v4zYQ/SvEnBJAlRyjJ93SjYEGyHYXG7eXIFjQ5MjihiK5JGVHMPTfi6EkW64323bRW32RQc7ne48zB5AYhFcuKmughDvUGJE12FjfsdaoGFhlPePT0Yabl5x9SPZc645VSkf0bNOx2DlkV3vrtcwYvjr0Co3AjFmnjLLmmkXL5JDAGt2x4FCoSonkGXK2rlVgKjDOJIboWxHVDpl16DmlY7HmkQlujI1sg6w10hokN0xlMedtpTSyK6mCs0ElJ24k23DxsvW2NfKa7ZXW5O08BvQ7lDlkcMxxL6EEoZH7zxTyc+paYYAMHPe8wYg+QPl0AMMbhBKSlZKQgSL8HI81ZODxa6s8SiijbzGDIGpsOJQHoFahhBC9MlvIIKqo6eAXauBeQt9nx9jJdgz8tUXfnUWuuA5nobnpPlSptvMkFHE8Ma3W0D9nf2F9opNVXMSBx5HW79E5q35N4fv/KCzV5zE4awIGamy5WNDnPPhjKwSGULWafRqNIQNhTUQTExzOaSUSq8WXQD6HGVjOE+dRDRnCEGxG0MZajdzMehwTEkOTkd18QRHPWHk6xno+uQ6valbmeSvTBWusRJ3e2/RMJl0GUim+8sZRwFnBpK+efhn8vFxewvQH10oOz2flvfU/jpHEyJWmfypiEy4NtBVnt/9Aj8pE3KKH/vkEKveedzPcH+xQIOmrCdvvPaL3GALfJiUOJm+bJjDYoNu/IZT6GlKPdjNmT/AO6L7dxt0A37eSTSa/rtcfLwIO3DYYa0uzaRBGGkexhhKK3U0hseKtjgXNolAcxpHUF7PhpUxlExxTKmVkUNs6MkrKbj/eX6hyukh6PNqP+uEi6WccVO+H3fDYhYgNYaCVQFL6yeTWcVEjW+YLyKD1GkqoY3ShLIr9fp/zdJ1bvy1G31A83L9b/fa4+mmZL/I6NpoC79CHobybfJEv6MjZEBtuZrne0fyeLyw2Q+KsycPpMfxfV98oxoivsXCaq/TOEkGHUWNPsLtJwCWVQZZ2HkFZnpbfEeDnDGobInkdDhse8Hev+56Ohw1G40CqwDd6tsPe5OTHF9O3unrB7rRVd1y3ZJLWzY57RSX9y/KuPo1j4pq9lXOaBqab55xqmQBM869GLtGnEobbWyHQxZnfxbim2o+j4W71sFqvoO//BMBMZxI=
sidebar_class_name: "delete api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -22,13 +22,13 @@ import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Clear agent memories"}
children={"Clear memory bank memories"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/memory banks/{agent_id}/memories"}
path={"/v1/default/banks/{bank_id}/memories"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
Delete memory units for a memory bank. Optionally filter by fact_type (world, agent, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The memory bank profile (personality and background) will be preserved.
Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
<Heading
id={"request"}
@ -47,7 +47,7 @@ Delete memory units for a memory bank. Optionally filter by fact_type (world, ag
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"fact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional fact type filter (world, agent, opinion)","title":"Fact Type"},"description":"Optional fact type filter (world, agent, opinion)"}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional fact type filter (world, experience, opinion)","title":"Type"},"description":"Optional fact type filter (world, experience, opinion)"}]}
>
</ParamsDetails>
@ -62,7 +62,7 @@ Delete memory units for a memory bank. Optionally filter by fact_type (world, ag
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"DeleteResponse","description":"Response model for delete operations.","example":{"message":"Resource deleted successfully","success":true}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"}},"type":"object","required":["success"],"title":"DeleteResponse","description":"Response model for delete operations.","example":{"success":true}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

18
hindsight-docs/docs/api-reference/endpoints/create-or-update-bank.api.mdx
View file

@ -1,13 +1,13 @@
---
id: create-or-update-bank
title: "Create or update memory bank"
description: "Create a new memory bank or update existing memory bank with personality and background. Auto-fills missing fields with defaults."
description: "Create a new agent or update existing agent with disposition and background. Auto-fills missing fields with defaults."
sidebar_label: "Create or update memory bank"
hide_title: true
hide_table_of_contents: true
api: eJztWN1v4zYS/1cI9qUNFNtJe72D3pw0aQPsboNN2pdNEEykscSGIlVyZMdn+H8vhpRsSd7strmHHtD1iyWS88H5+o1mIwkKL9MPcl6gIfEWDBRYoSF5n8gcfeZUTcoamcpzh0AoQBhcCQjHrRNNnfMqPitPyhTtxkpRKWp03hrQitYCTC4eIXsqnG1MPhHzhuzxQmntRaW8Z8qFQp37SJrjAhpNfiITaWt0wDpc5TKVWdDiwbqHKPkhCJSJrMFBhYSOr7ORBiqUqQy7DyqXiVR8iRqolIl0+HujHOYyJddgIn1WYgUy3Uha10znySlTyESSIs0L0T5Xudxu7yM9ejqz+ZqJxuwya4i1SjcS6lqrLOg//c2zITc9abXj25FCz29R540Es/55EW4x1Gab7FZMo7VkTTr93jHtNpE9ow9ZDUXZGo1B73tXNk31iE4msoJnVTWVTE8SWSkTn2d7UT93tOMI6TYEWYHPNTqFJkPx9ez45BvWLbPGZwoNKdv410o/P2ByEKjjE3sN8JkcLNF5FT3xV4Vf9OnHcvube5FQOER41PjaC88HDMZCB7t7qQYbZ0llylevkfmuRz6W2Nvby3tU4B88OTQFla+ReKbAi5uOwVjmT3YlPDlrCr0e1BVlFrrhKPPC1sooa3ZG2CadEvbxN8xokPYf9hnwsbgcRcrYi0P7jm/fy8rrvaq3DhQd+q93QlA4Ih7BYy6sEWeqEJdqiaKyOepJ0AqqWsciMYyr2eTfB14Iax9Jutnk+3EqzCb/GgXNbPJt0isTs8l/tof1hz2/q+qvLV1new4fc9ou8UPlD3X4fSy/B8Zs16O9xMI6EeBCmWIa0CIAlIkYNTJn/xrySkAloCVeovB2QStwKNAUyiC6iFInM7FGcF7YRa/ecXRE8JlrFV7HNflv8Bz/OP59bY2PEHA6m/Hf0II3TZah94tGi/ftYflqPNuB75/C1WSHfy+dfQHjviDbF2T7gmxfkO1/QrYRjr1Ugj6DVX039D49QmEb1q2BwPtRPbx2dqE09irwGOfiRg/o4ndXHQkPDNrVYdl4dCen3w7F7wDvL+GcUEZ4AkdN7f+PMe+709NDmPsVtMoDiIkL56x7PcblSKA0PynCyh8e0DYb7P6JDkkZwgJd7K/aNXAO1r1AfGOjglyiKl98KmbfovdQBOSMR14+Gowhbnn3c+HN94qi23O9IN6bN1r35Wv8EM33qb7vp9vb6wOG0bcVUmk5fusmjgA4juQUajVdnkxD2Pvppgv/rUwku/P9/uP94h/TAPL8Y2GD7wed11usrFuL+fXVQZW5M3NBWNXWgT72WIEhlYkqEvi1J6xC6ZlfxerjBZVAwpN16BPhkJzCJT/y9McheMYwu0QXmSj0kztzZ776SlwiUOPQ8+uRODo6A8rKTrcbsg4KPDpKwyOKqtGkao07NgIXCxUspdfRM9CQrYD1XUBGIlgs43tF/jfdbW4QXFYy60sVlNS4BEN7zk2YTRlWD7TQYIoGChS/N+xsH7ldsghOGnGpNCHnVFA28BaQOeu9WFmn86ANGyTYPmrU2mcH8h55lEWo15H7banMk7gweW2VIWb8IxoeiaEINeuZGtACjF+h60FsFKFyDp92ANddKvL90UFdil+Vb0Cr/4bkYuZXhjDYaomdr4twctk/GVn8YLOGh4Xi1kH21F47PEd5YZrYccnbw+2Ir6k9OhK+qWvrqI2DuctKRZhxMPDSbYldpDUefXpnjtkibVCKN8o8eZZ5bo3BrOe2EImcsJm2PkAVqQoj+c75B+RdkIPWa+FVpTS4ntWY+CKa8zOSq5C0RhDrDxXXDVK0Y3JTO4ScA2vOhh7YXmsVPNemOER4b23Y5hToOyPaXwtdkNF+hCi7zAmm4/LLhYg7if2ReQ1ZieJ0MpOJbJyWqSyJap9Op6vVagJhe2JdMW1p/fTN1fnFu5uL49PJbFJSpZnxrgzJk8lsMgufZ9ZTBaYnqx0d78fF3dB2UHA2ewz+24bNLQhxVk1rDSrga7DOpoWXDxJqJRO5PAnNMwe0TGS667HuE1laT3xws+Fs/MXp7ZaXuWasZfrhPpFLcIoBIPQBufL8nMt0AdrjJ6zy9fsWgL8RL+na4axhlF2CbvhNJvIJ1/1xeGgtSoQcXdAhbp9HScehAdiTH/RD3KtEinmWYU2fPHvfw+nrX2659WzH5ty9ylQ6WHFvAauoqQ0XD71SWNvIrurKVEaW/PsDEJiTiw==
api: eJztV01v2zgQ/SvEnBpA8Ve2FwE9JGmABki7QZLuJQgCWhpJbChSJSl/QPB/XwwpW1IcZ7PBArsL1BfL5Az55unNo9lAijYxonJCK4jh3CB3yDhTuGQ8R+WYNqyuUhrFlbBOqLydWApXsFTYSltB6YyrlM158pQbXat0xE5rp48zIaVlpbCWMjOBMrVtKma8ls6OIAJdoeG0yGUKMSQexaM2j2HnxzlXTxBBxQ0v0aGxEN83oHiJEANNPooUIhBUQsVdAREY/FkLgynEztQYgU0KLDnEDbh1RWnWGaFyiMAJJ2ngjKsndpnCZvMQ0tG6M52uKef5aolWDpWjKV5VUiQe/PiHJRab3maVodKcQEu/AuIGuFr/nvkahmA20W5E1VICIdnC+0a5mwh6jA+XGm5ln7ByIhG27NUslMMcDURQ8pUo6xLijxGUQoXnabfbbZcePdPIF71k7epcsoVlztRBFx+mn7bPEfv4aRd0RLilcGi4fC+gqy79JUDt6nLNnGa0qqkMOiZUpk3pXw6hyySuxFwioWszPDYsSTXrdwG7aHNfQlXWSUGAEq2sSNEwLDVNc8m8glaOUKXoeFJgSqgCEnQiOYLNJtrC0fMfmLiBrO/7r3hAb1dPTz6fO9ncGS6c3QPci2DOhzBXcM+hrFElyAoqCUttBFrGDTIiF1Pf+DvOMaWGxhUvK+nFviP3ZCiCk2gg0pPNvvo3EXSG8t7GOetWeInRbViwPjKBm9D7ewS146zUKUqqnXmjEiofe5/y1sjIjp4x0K8BLhkvGW9TF8isztySyESVC4VogjtOJ2yN3FimM4arCo2gVwB7/f9mdqOtX55KkSBs6EN6spVWNnjGbDKhr2HVt3WSoLVZLdlNGwzvNsCtV7/FhqOdXR4KPWCJv4zwlxH+z43wme0d7pVXra3PUfcvyXfVsGkG+z0Me/Ha6ExI7PX+c1cMEz1bpL1YFfLeYIV/ywGZUMw6blxdWY+7NRSoLZrp7OQfd8jfZrN9U/yDS5GGbrowRpv3OyJpXkh6Eg5Lux8gdTKYfcMRuO1Zf4C2Y9wYvu5J50oHgNT1pc1fU9lXtJbn3mlDyOFQTwa7o9m/EiTVFbZu43q66+gN7B4u43Og77WD/cvd3fXeguHdlugKTeKpaufvF66AGMaL6bi9nIxJX3bctDLbQAT0Qm+628HFf/yYp1tRpv072/IhVGpFXjhGzLDT68t9y24nfDfv4luR88R1dxn4Sja4Zrdr67AMx1uC5BNdyGlFrs5mowlEUBsJMRTOVTYej5fL5Yj76ZE2+bjNteOry/OLb7cXx7PRZFS4UtLCCzQ2wJuOJqMJDVXaupKr3l7tBba7tJYBX3uDHJTZdD37r118W9HSCTiuJBe+Hz1HTSvHe1hMPXKf1FoeWV+89b6HCAptHYU2zZxb/G7kZkPDP2s0a4jvHyJYcCP4nARw35C46DmFOOPS4iu8fLhpW/aIHUK77UxFfbngsqZfEMETrnu3c+9FBfIUjYcQZs/DRsfeMbrsPQMlcwsZp0mClXs19qHX2Nff74iy9hpPRxTEYPiSzIgvA1Dt6/bm6scakFzlNVleDGFJ+vwJ2q/ySQ==
sidebar_class_name: "put api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -22,13 +22,13 @@ import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create or update agent"}
children={"Create or update memory bank"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/api/v1/memory banks/{agent_id}"}
path={"/v1/default/banks/{bank_id}"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
Create a new agent or update existing agent with personality and background. Auto-fills missing fields with defaults.
Create a new agent or update existing agent with disposition and background. Auto-fills missing fields with defaults.
<Heading
id={"request"}
@ -47,14 +47,14 @@ Create a new agent or update existing agent with personality and background. Aut
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"personality":{"anyOf":[{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}},{"type":"null"}]},"background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Background"}},"type":"object","title":"CreateAgentRequest","description":"Request model for creating/updating a memory bank.","example":{"background":"I am a creative software engineer with 10 years of experience","name":"Alice","personality":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}}}}}}}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"disposition":{"anyOf":[{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}},{"type":"null"}]},"background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Background"}},"type":"object","title":"CreateBankRequest","description":"Request model for creating/updating a bank.","example":{"background":"I am a creative software engineer with 10 years of experience","disposition":{"empathy":3,"literalism":3,"skepticism":3},"name":"Alice"}}}}}}
>
</RequestSchema>
@ -62,7 +62,7 @@ Create a new agent or update existing agent with personality and background. Aut
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"agent_id":{"type":"string","title":"bank ID"},"name":{"type":"string","title":"Name"},"personality":{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}},"background":{"type":"string","title":"Background"}},"type":"object","required":["agent_id","name","personality","background"],"title":"AgentProfileResponse","description":"Response model for memory bank profile.","example":{"agent_id":"user123","background":"I am a software engineer with 10 years of experience in startups","name":"Alice","personality":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"bank_id":{"type":"string","title":"Bank Id"},"name":{"type":"string","title":"Name"},"disposition":{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}},"background":{"type":"string","title":"Background"}},"type":"object","required":["bank_id","name","disposition","background"],"title":"BankProfileResponse","description":"Response model for bank profile.","example":{"background":"I am a software engineer with 10 years of experience in startups","bank_id":"user123","disposition":{"empathy":3,"literalism":3,"skepticism":3},"name":"Alice"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

8
hindsight-docs/docs/api-reference/endpoints/delete-document.api.mdx
View file

@ -5,9 +5,9 @@ description: "Delete a document and all its associated memory units and links."
sidebar_label: "Delete a document"
hide_title: true
hide_table_of_contents: true
api: eJztVk1vGzcQ/SvE5JIYG8kxetqbGsupAacNYjUX2wjG3JGWMZfckLNyVGH/ezHkrj7iOkWBoqf64hU/3gzfzLyZLTCuIpQ3cO5115DjCHcFVBR1MC0b76CEc7LEpFBVwxmFrlJorTIcFcbotUGmSjXU+LBRnUvrrlLWuIc4uXW3blGbqB6NtUpj1FiRqhJqeeteq0VNe2zDkexSlmfWHkPSNw6oxdIy+EaxYI73xgvJpHrJ1LQ+oC1UpAYdG10ocmx48+rQ40fDteLaRzqytPPYtxRQaFAanfOs7kl1rvKOJlDAbveyghLygz6PDkEBLQZsiCkIw1tw2BCUgCty/NlUUIARelvkGgoI9LUzgSooOXRUQNQ1NQjlFnjTyr3IwbgVFMCGrSzMBEhdVtD3xQ59NP9vGBhzItu4E4jYehcpyq2z01P5d5wr153WFOOys+rjcBgK0N6xUFJuAdvWGp1Ym36Jcme796Tv+76An87OngJ/QmuqHIp5CD78A1Rog0SKTfa7IkZj5cswNfHpAev10S66zW/LFMFjooT1YcU4phUF6O/6YlzDEHBzwOaVzw5CX0ATVz8i/j3FiCuCHdjzRxMZaiG7/d62v/9Cmo+CfpPelU0P5+72MHt6M7vPP+M80/dXxsYjvywWH54A5tg2xLXfV0sqEq6hhCm2Zrp+M03VEafbsUr66ZjRcbo9SO4+ZffSJ26OCuJ9LuTZh0v4Xslu3UyNyvB6FIax8uMmMjVq6YOaXarsh+IaWUX2gWKhAnEwtJZPUbdAGL2Lyq8pZBBDWe1evFAXhNwFSlJyok5OfkbW9ejbNfuAKzo5KdMnqaazbFpLOxhFy6XRhhzbTVYp7Ng3KP4uUfOohcYP+Nfja64Jg64F+sIkJy2t0fEeuYvGrZQT99Aqi27V4YrU145kO6NdiAlJKnVhLJPkXHI2YSvUwceoHn2wVfJGCEncZ48GfnxrnPxSkUQJmewmoy9q4x7U3FWtN44F+B05kVJSqaa/cYdWoYuPFKK6x0iV8m4wYaqs48nE+KiM+y5gW6tPJnZozR8p+QT80jElrtY7lV+lk+vDkxliJ3mLgPpheHb6zvbQCVcDyi4zc4S6NlJgFbu29YGHPJgFXRsmLcmQ2wqNmdZFiqn/nZwshqRUV9K+xOZb7xzpg7ClTMRASltpV8YpNg3l67vgP7k+Jjlau1HRNMZiOGBNLs8znX9jWd4p4sviPzaUu+kO5LoNhJUk1kyIPuLeWpMixwHXFCLaVGMDh0NNob11avgbpB11kvahr42Vk6gTebJGk3SX/ZFZi7omdTY5hQK6YKGEmrmN5XT6+Pg4wbQ98WE1He7G6dXl2/mv1/PXZ5PTSc2NFWDxMcvFm8np5FSWWh+5QXdg68lM9L3WbPft6f8B6rkBamggUvHT1qJJvTFFbjv0hRvA1kAB6zdQ5MkpQgHlwQy1K0JZP5x+7gqofWTB2G5FRH4Ptu9lWaRuA+XNXQFrDAbvpXvcbKEyUb4rKJdoI/0goi8/Dn31lXruGWP7dNI812g7+QUFPNDmcAiUIeI/tHtIUBpWasKKQnp+PjHTmlo+uPtktpJJcNfHz+dX88Uc+v5PedtN5A==
api: eJztVU2P2zgM/SsCTy2gxpmgJ99mdwJ0gOm26KS9ZIKCkZlYHVlyJTppYPi/LyTb+Wh2Ciyw6GlPtinykXp8pFsoKCiva9bOQg53ZIhJoCicaiqyLNAWAo0RmoPAEJzSyFSIiirnD6KxyW4LYbR9DpMn+2QXpQ5ir40RCoPCgkSRUPMn+0YsSjphaw5kNtF8a8wlJP1gjypm2nhXCY6YY9wYkFKKV0xV7TwaKQJVaFkrKciy5sPr84r3mkvBpQt0kelYsavJY6RBKLTWsViTaGzhLE1AwvH0voAc+gt9HQsCCTV6rIjJB8iXLVisCHJYo33+qguQoCO7NXIJEjx9b7SnAnL2DUkIqqQKIW+BD3UMC+y13YIE1myi4Q+0z+K+gK6TR+wx+X+Bfzd2JOVYRYhQOxsoxKjZdBofl0p5bJSiEDaNEZ8GZ5CgnOVISN4C1rXRKnGWfQsxpj1V0nVdJ+HtbHYN/AWNLvpGzL13/l+gQu1jn1j3dRfEqE1800xVuHYwTl2coj182KT+XRIVWR8s2jJtyUO36uRoQ+/xcMbmg+sLhE5CFba/Iv49hYBbgiPYy66JDLGIp90pt1t/I8UXTV+me/WpB7/VCeZEb8/uy9e46+n7p2Sjy7vF4uMVYN/birh0p1lJI8Il5JDtbrKCNtgYzuJ8hKwdxqTLRk2HrD2Td5f0vXGJnTGztkXQ25JFrEHcfrwH+ZOQxgOxcV4c/Qc5oUpyGmbpfb8QHg+BqYqUGK0oKvrkclujKknMJlOQ0HgDOZTMdcizbL/fTzAdT5zfZkNsyB7u/5z/9Th/M5tMJyVXJgLvyIe+vJvJdDKNptoFrtCe5brawj/frT2NxP8r+6WVPYiW6QdntUGd5jF1rh20uITdTaI2qRFk2tcBJOSnxX2UZDSf79yVhNIFjihtu8ZAn73pumj+3pA/QL5cSdih17iOil22UOgQ3wvIN2gC/aKnrz4N0/xavHSRcWhtHNkdmiZ+gYRnOpz9eOLm+o1pz/lJG7IkLMin2/cet0pRzWexVws9/n6Oy+Nu/jBfzKHr/gaan/5N
sidebar_class_name: "delete api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"delete"}
path={"/api/v1/memory banks/{agent_id}/documents/{document_id}"}
path={"/v1/default/banks/{bank_id}/documents/{document_id}"}
context={"endpoint"}
>
@ -54,7 +54,7 @@ This operation cannot be undone.
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}]}
>
</ParamsDetails>

71
hindsight-docs/docs/api-reference/endpoints/delete-memory-unit.api.mdx
View file

@ -1,71 +0,0 @@
---
id: delete-memory-unit
title: "Delete a memory unit"
description: "Delete a single memory unit and all its associated links (temporal, semantic, and entity links)"
sidebar_label: "Delete a memory unit"
hide_title: true
hide_table_of_contents: true
api: eJy9VlFv2zgM/isC97IVbtIW9+S33JruCnS3Yc320hYDZzOxVlnyRDpdLvB/P1C2k3S97nDAYXmJLZMfqU/kR21BcMWQ38BbqkPcmHcNRRQbPMNdBiVxEW2j75DDOTkSMmjY+pUjU/curbdi0JcGnTNW2CBzKCwKlcZZf8/mpVDdhIguM0w1erFFljzIi5VNb/UKMghj9MsScihTvM99mM8aBjJoMGJNQlGz3oLHmiAHXJGXz7aEDKym2qBUkEGkb62NVEIusaUMuKioRsi3IJtG/Vii9SvIQKw4XZgpkLksoeuyHbqG/j/APypTCftO3bkJnonV4+zkRP8e833dFgUxL1tnPgzGkEERvJAXNcemcbZIhE2/svps91l0Xddl8NvZ2VPgT+hsmdzMPMYQ/wMqNFEPSWyfd0mC1umTFar5qYELxaOv6DfvlunkHpOkbA8r1gutKEJ312XjGsaImwMmr0KfIHQZ1Lz6GelviRlXBDuw500TGWahX7t97PDlKxXy6MBv0r760IPd3R5mT2/P7vPbOO/p+6dgo8kfi8X7J4D92dYkVdg3SmoOqSCHKTZ2uj6dpq7g6Xbsjm6aeskST7dDTXepqJch0fKoBwZBmL2/hB+F4NbPzNjSx2NHj3LAGxaqzTJEM7s0fQpGKhTDEiJxZiJJtLTWRxWBSMjBswlrimZMcHLrb/2LF+aCUNpIrK9H5ujod5SiGnO7lhBxRUdHeXokU7dObDNKkyU2tFzawpIXtzEPViqDrYQaNd8lFmLou0QsdF89/vW4m2vCWFQKfWFTko7W6GWP3KoKGq/poTMO/arFFZlvLennHu1CQ2g9mQvrhLTcUrIJ22ARA7N5CNGVKRslJHHfZzTwExrr9c0wqfgJuU2PvqisvzdzXzbBelHgN+RVQMmkdv4uLTqDnh8osvmCTKUJfghhy0F8NcS4qR73TcSmMp8st+jsX6nuFPzSCyWu1jvpXyXL9aFlD3EeirbWMIuIxf2w7fTcx0OvXA0o5WDM/Qm1DVMUw23ThChDHcxiUVmhQotBlxYVjZXWMnF+64+VkaEozZVOFI35OnhPxcGxpUrESKZwgclYb8TW1LvvDv+J+1jk6NzGsK2tw3jAmjrPezr/JbLuU3VXNH+sqR+BO5DrJhKWWlgzJfoR987ZdHIScU2R0aUeGzgcegrdrTfDb1B1LJKqD6Ns7JxEnSqTswXpYNmbzBosKjJnkxPIoI0OcqhEGs6n04eHhwmmz5MQV9PBl6dXl6/nf17Pj88mJ5NKaqfAmmMvF6eTk8mJLjWBpUZ/EGt3pTi4S/woN9v9cPoFV5BBh7V7po1Dm0ZMYmE7yOsNYGMhg/UpZP3FgyGD/OAKMh65Lo93h7sMqsCi7tut9uLH6LpOl1UxNpDf3GWwxmjxi4rwzRZKy/pcQr5Ex/QTVl5+GCbTK/PcDsYB5HX8rNG1+gYZ3NPm8PqkY/gXxh3JSaO+Iiwppq33X2dFQY0c+D25meg9ajcFz+dX88Ucuu5vWrnCbA==
sidebar_class_name: "delete api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete a memory unit"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/memory banks/{agent_id}/memories/{unit_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete a single memory unit and all its associated links (temporal, semantic, and entity links)
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"unit_id","in":"path","required":true,"schema":{"type":"string","title":"Unit Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/get-agent-stats.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-agent-stats
title: "Get statistics for memory bank"
description: "Get statistics about nodes and links for a specific agent"
sidebar_label: "Get statistics for memory bank"
hide_title: true
hide_table_of_contents: true
api: eJylVE1v2zAM/SsCTxugxWmwk2/dFnQB2q1Yu12CoGBsxlZjS65EpwsM/fdBsvPVrAWGneLw8/HxiR3k5DKrGlZGQwpXxMIxsnKsMidwaVoW2uTkBOpcVEqvnVgZK1C4hjK1UpnAgjSDBNOQxVBnlkMKBfFD9DyEeg4kNGixJibrIJ13oLEmSGGJev2gcpCgAoAGuQQJlp5aZSmHlG1LElxWUo2QdsDbJqQ5tkoXIIEVV8HwCfVazHLwfhHSXWO0IxcyJuNx+Dkd9K7NMnJu1VbixxAMEjKjOQyTdoBNU6kszpM8upDTHVB4772Ej5PJeeFfWKk8pomptcb+Q1VobOCQVY87J0ZVhS/FVLvzgMpkJ17U2++ryO0pSV7uLUozFWTBL7zc2dBa3B4xeW16gOAl1K54i/Qbcg4Lgn2x10MjGeI+eP2ht1k+UsYnC5/HufrWQ9ziUOZAb8/u62N86en7W7NdyNf7+9uzgv1ua+LSDDqO2uUSUkg2F0lOK2wrToJwXdIN+vXJTuZKr0wkYtdE6dypomQR2onL2xnIF5rZOeLL2scPysEsKmd4LjdUG7sVd1vHVIfpK5VREO8h5LLBrCQxGY1BQmsrSKFkblyaJM/PzyOM7pGxRTLkuuR69nn67W76YTIaj0quq1B4Q9b18C5G49E4mBrjuEZ91OvFvQj46x5h4OXloN3hKfzXpRn2yfSbk6ZCFaUaJ+2GTc1hcxG7x12BjGcmbCc93Jt+YQsJpXEcUrpuiY5+2sr7YH5qyW4hnS8kbNAqXIZ1zjvIlQvfOaQrrBy9MeO7H4Oq34vXUO/Eq4N0N1i14R9IWNP26DjG51oS5mQjhN57mWXU8FHe2XUJt3Cv5KvpPXj/B5zBBYM=
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get statistics for memory bank"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/default/banks/{bank_id}/stats"}
context={"endpoint"}
>
</MethodEndpoint>
Get statistics about nodes and links for a specific agent
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

14
hindsight-docs/docs/api-reference/endpoints/get-bank-profile.api.mdx
View file

@ -1,13 +1,13 @@
---
id: get-bank-profile
title: "Get memory bank profile"
description: "Get personality traits and background for a memory bank. Auto-creates memory bank with defaults if not exists."
description: "Get disposition traits and background for a memory bank. Auto-creates agent with defaults if not exists."
sidebar_label: "Get memory bank profile"
hide_title: true
hide_table_of_contents: true
api: eJzFV0tz4zYS/iso5JK4aEl2sskWb5qJPXHVzMQVO7mMXVNtskUiBgEG3ZStVem/pxogJUqax64PG19MAf380P01sNYMFen8g55X6Fi9AwcVNuhY32e6RCqCadl4p3P9Blm1GMg7sIZXigMYJgWuVA9QPFbBd65UCx8UOAVibqLmHfvTIiAwUlpTT4ZrVeICOsukzEI5zwqfDTFNdKZ9iwHE41Wpc10hf4xqH9vgF8aiznQLARpkDBL3WjtoUOc6SZlSZ9pItC1wrTMd8K/OBCx1zqHDTFNRYwM6X2tetaJHHIyrdKbZsJWFBMRVqTebe9Gn1jtCEpXz2Uz+7cNy0xUFEi06q37rhXWmC+9YUMzXGtrWmiLmNP2TRGc9CqMNkjGb5GGbxX8VYNYn/3nZ97K/yfTo3I6d+hadQ6KRIdc1Dxh0pht4Nk3X6Pws041x6Xu2c/DroHtYLcOGYq/wucVg0BWovp2dnn0nERXeUWHQsfEdvdT76yMjh2EcSewiwGcOsMRAJp3J/+r8Yqx/6He8uXMJVUCEB4svTXi+Z+DQ6d7uzqvDLng2haHmJT7fj9QPPY72dv4eDNBH4oCu4volHl8ZIHUzGDj0+Yt/UsTBu8qu9gjJuIXtpMpI+dY4490WhE02BOEf/sSC95jhw64DPlWXB5VyeIr7+B5mf7/L6noX6m2kzqPMro/Z9QEIS+WdemUqdWmWqBpfop3EqKBpLSba2Kur2eSno1OIa59outnkx8NWmE3+dVA0s8n32YgmZpN/C6I71v8SBb3aSX3tGEYcHoltn7f2HN4f8OF1Gg8jBt6HdthI8KUpFXm0nytHgA48rDvCcHb+/b77XF8paBQo8gt+goAKXWUcYkjz7WymVgiBlF+M2c84RQyBu5aGHHM9t6Y4zPUfOlP5y/QP5+fHY+4PsKaMQ0xdhODDy2dciQzGypdhbOhYwPpibxfc6tdFnPX7NbbJtivGMVYY9OZ+V2IQAqxGhfjWpwCFohqqvlSz75AIqjg5k8jnRSMY6lZ2v1bekldy3cuNingHb0L382n8nOD7lLNB5Jfb2+sjg+lsG+Ta9zereJeSOtJTaM10eTaNZU/T9VD+m+nu2mXcwkcg9q4h77DxYaXm11dHLXfn5oqxaX0Ae0rYgGNTqCYp0IoYm9iH86vUiqS4BlbEPiBlKiAHg0v5lCtmQCAhdL/EkIwYpMmdu3PffKMuEbgLSPLzRJ2cvAIu6iG2G/YBKjw5yeMnqqazbFqLWzMKFwsTe8iuUv9Cx74BiXcBhVxPOUAheSX7N0M2NwihqMX0pYlBWlyC453ljoyrlJPwwCoLruqgQvVXJ5RAydqluJAKUpfGMkqBxWCjbQVF8ETqyQdbxmgEkIh9iqjHZzvxCOWCzGhXyfptbdyjunBl641jMfwGndyxUcUGfuYOrAJHTxhG8ya5MKUQC6+iiyGpZPdNgLZWfxjqwJr/xEoT41eOMWK1xOGsqyi5HEsmEz/7opO3hroNUDz2acfv5C8+RgYrZS9M6YS6ljCwoq5tfeC+DuahqA1jIcUgS7c1DpXWEVJ+504Fkb4o1VvjHkl8vvbOYTE6tliJQuuF9RR5m02DSX17+EfqQ5GDtStFpjEWwgg1Ub5IcH7FcxPp3CmW+KGR6cKGt0Zu2oBQSmHNBeg97K018eR68oc063oM+54Ce+dU/9fzOBSRx/uRNHROhE64SEaUjNWdyLyFokZ1PpnpTHfB6lzXzC3l0+nT09ME4vbEh2ra69L07dXri/c3F6fnk9mk5saK4e2A0meT2WQW3yqeuAE38iUvz71pfcg1690s+j89U3vqlfaZthZMnCoRhnVPqh80tEZnenkWr4xSuTrT+eiOMyRzn+naE4vKei0N+Huwm40sC02sdP7hPtNLCEZuA3EOlobku9T5AizhF9D49rd+AH2nPhf1MGecTJkl2E5+6Uw/4mr8ro6jtUYoMcQY0va8KLDlkeLRTUBe0dup8+biVm82fwMQd7Yf
api: eJy9Vk1v2zgQ/SvEnBpA9Ve2FwE9ZJugDZB2gya7l8AoaGlsseGHSo78AUP/fTGUbEl1khY5NJfI4gznzeObR+0hx5B5VZJyFlL4iCRyFUoXFL8R5KWiIKTNxUJmjyvvKpuLpfNCCoPG+Z1YSPs4EhcVubeZR0kYhFyhJbFRVIgcl7LSFIRaCutI4FYFCiNIwJXoJRe5ziGFFdI33ulb6d1SaYQESumlQUIfIH3Yg5UGIYUYpHJIQDHgUlIBCXj8USmPOaTkK0wgZAUaCekeaFdyWiCv7AoSIEWaX/wt7aO4zqGu55weSmcDBs6YTSb8b0jMXZVlGMKy0uJrGwwJZM4SWuJwWZZaZbGh8ffAOfseitJzu6SaCocefgde0jb+fOgXXq8T6J3bacnwiCWpTAXT20pZwhV6SMDIrTKVgfRdAkbZ5nna1bjr0pOfmPnkNqLdXWqxDoJ8FUjZlXgzfX94TsS798egM0arFaGX+rWAbrr0pwC1u+udICd4V196JKHs0nkTD4nRLTVu1UIjo2szIjY0LKvdq4BdtblPoTJVVjCgzNmgcvQCjeNlqUVU0pYYVY4kswJzRtUgQVLZGdR1coDjFt8xo4HuH/pHPKC362fewbzsxHIfZ/wE8OWpDVAhI4e6QpuhKLglNgHFM++RfcFgHt3iyDnmPOy4labUUcZHcs+HIjhPBiI953Y7z3l5Vo5Rv+Koc484VcOhGdSbD2fxtrGl3uwP2TosCONy1NEhuZZo7ewnDvp9wbWQRkgR3JI2zCLalbKIvjHQ6UTsUPog3FLgtkSvIvfKikDSU1WGiLs1FKgC+unsHE7s4LdpPxgOXGiVIdT8l8Bfs9mpKf4ntcqbabry3vnXOyJrXml+UoQmnAZolw1Wpd39s4z3wlAVdXIys/W8E4X0Xu560rlxDUCeehNWL6nsM4YgV9Fpm5DnQyMZ4p5XfyVI7qsp3cb1dNfR27D7fBuXDX1PFTuEfLq/vz3ZsDlbg1S49hKO9y4VkMJ4PR23t/eY9RXG+1Zm9bi7pNlRIxWHMsrmQa0KElxQXNxenzphuxCH5BjfakdmUTutBD83nxh3u0BomlsjQx6/LuSiZLMUs9EEEqi8hhQKojKk4/FmsxnJuDxyfjVuc8P45vrD1Ze7q7ez0WRUkNG88Rp9aOBNR5PRhF+VLpCRtleLv456Xz2io2HQ4b6bgj/5QdWePF8j41JLFUUdGdm3Z/oA62kEG7dofYP9I+188dDTPIHCBeKk/X4hA/7rdV3z6x8V+h2kD/ME1tIrueCDf9iz4fBzDulS6oAvkPLmazsBZ+I53AehW5b5WuqKf0ECj7jrfQTG0S5Q5ugjhGb1IsuwpF7eiRPxN99R9R+v7qGu/wfoX8zO
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/profile"}
path={"/v1/default/banks/{bank_id}/profile"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
Get personality traits and background for a memory bank. Auto-creates agent with defaults if not exists.
Get disposition traits and background for a memory bank. Auto-creates agent with defaults if not exists.
<Heading
id={"request"}
@ -47,7 +47,7 @@ Get personality traits and background for a memory bank. Auto-creates agent with
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
@ -62,7 +62,7 @@ Get personality traits and background for a memory bank. Auto-creates agent with
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"agent_id":{"type":"string","title":"bank ID"},"name":{"type":"string","title":"Name"},"personality":{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}},"background":{"type":"string","title":"Background"}},"type":"object","required":["agent_id","name","personality","background"],"title":"AgentProfileResponse","description":"Response model for memory bank profile.","example":{"agent_id":"user123","background":"I am a software engineer with 10 years of experience in startups","name":"Alice","personality":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"bank_id":{"type":"string","title":"Bank Id"},"name":{"type":"string","title":"Name"},"disposition":{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}},"background":{"type":"string","title":"Background"}},"type":"object","required":["bank_id","name","disposition","background"],"title":"BankProfileResponse","description":"Response model for bank profile.","example":{"background":"I am a software engineer with 10 years of experience in startups","bank_id":"user123","disposition":{"empathy":3,"literalism":3,"skepticism":3},"name":"Alice"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/get-bank-stats.api.mdx
View file

@ -1,71 +0,0 @@
---
id: get-bank-stats
title: "Get memory statistics for a memory bank"
description: "Get statistics about nodes and links for a specific memory bank"
sidebar_label: "Get memory statistics for a memory bank"
hide_title: true
hide_table_of_contents: true
api: eJylVktv3DYQ/ivE5NIayq5t9KTbNrFdA04bxNtcbCMYU7MSY4pkyNE6m4X+ezGUtI+6SVHUF1PkzDcz37x2C4x1gvIOFjU5Vu/QYU0tOYaHAipKOprAxjso4YpYJUY2iY1OCh99x8r5ipJCVylr3FNSKx8VqhRIm5XRCgUVCvCBIgrOdQUl1MSf8ssnwUtQQMCILTFF8WULDluCEgYZU0EBRjwIyA0UEOlLZyJVUHLsqICkG2oRyi3wJohe4mhcDQWwYSsXQ3DXFfT9g+in4F2iJCrnp6fy7zjU205rSmnVWfVhFIYCtHcs4ZRbwBCs0Tmi+eckOtu9G33f9wX8cn7+EvgjWlNlNXURo4//ARVCFBbZDH5XxGisnAxTm14KWK+PXtFt/lhldo9Z6ovdjXFMNUXoH/piusMYcXNA5Y0fHIS+gDbVP2L9HaWENcEO7PuimQy1lNd+b9s/fibNRxm/y3ENpke5hz3Mnt6B3e+H8Xag75+MTSK/LZfvXwAOuW2JGz9Wcq5ebqCEOQYzX5/Nc9mm+XYq334+lblxK59pOKrLd9T6uFGL99fw9567dwvF1AYf0b5O1KJjo1U7KKRNYmpzyy2uh1ZLihuUNvWRUqEicTS0lqO0aCRM3iXl1xQHEENpdu/u3atX6pKQu0hJPk/UycmvyLqZfLtlH7Gmk5MyH0m1nWUTLO1gFK1WRhtybDfq2XCjsGPfovi7Qs2KvnJELXEN+LdTNLeEUTcCfWmyk5bW6HiP3CXjauXEPbTKoqs7rEl96UieB7RLMSH1oy6NZZLyys5mbIU6+pTUs4+2yt4IIZn7waORHx+Mky+VSAYSk90M6MvGuCd14argjWMBviInE41Ubt+v3KFV6NIzxaQeMVGlvBtNmIocG95kE1NQA+5VxNCojyZ1aM23XGcCfu2YMldrmnJdZ8n1oeQA8dbrTua1WkbUT2PY+TzYywN9QqlG4TRkqAuJIqvUheAjj3WwiLoxTFqKQa6WDU2V1iVK5b17LYyMRaluZOyLzTfeOdIHacuViJGUtj6RMk6xaWlQ3yX/hfpU5GjtRiXTGovxgDVRvhjo/BfLEqfMWRb/sSWVs7ADuQ2RsJLCWgjRR9xba3LmOOKaYkKbe2zkcOwptPdOjX/jFEedp/i4vKbOydTJJLJGkyySvcgioG5Inc9OoYAuWiihYQ6pnM+fn59nmJ9nPtbzUTfNb67fXPx+e/H6fHY6a7i1Aiw+DuPibHY6O5Wr4BO36A5syfae5sZ+ied17XZr+mj4bPer6X/t/nG+SpfMg0WTV0eOdjtOzjvAYKCA9RkUw9KXYVkerP9hgD4U0PjEorDdSpf9GW3fy7XMgg2Udw8FrDEafJTxereFyiQ5V1Cu0Cb6QYQ/fRh3zM/qez5Pq8TJIlmj7eQLCniizeGPlbw9G8KKYvZheF5oTYEPFF8se/lpslssVxdL6Pu/AGALWMc=
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get memory statistics for a memory bank"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/stats"}
context={"endpoint"}
>
</MethodEndpoint>
Get statistics about nodes and links for a specific agent
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/get-chunk.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-chunk
title: "Get chunk details"
description: "Get a specific chunk by its ID"
sidebar_label: "Get chunk details"
hide_title: true
hide_table_of_contents: true
api: eJydVU2P20YM/SsDnhpAK8lOetFtm11sDSRtkHV7qGEYY4myJpE0ypDyriHovxcz+rC07q6D+mJp+Dh8JB+pBhKk2KiKlS4hggdkIQVVGKtUxSLO6vK72J+EYhKrO/BAV2ikBa8SiOCAvHMY8KCSRhbIaAiiTQOlLBAicNadSsADZQNUkjPwwOCPWhlMIGJTowcUZ1hIiBrgU2X9iI0qD+ABK87twUdHZZVA226tP1W6JCTrsgxD+zfP5LGOYyRK61x87cHgQaxLxpItXFZVrmKXS/CNrE8zoVEZmymrLsKYxU8R9CDRcV1gyVdc7npY77WXV4P8JscYPacyweeJhyoZD2gueTnc6Mb4zNeTWVuU9TEoGZOdfNunQ4lbhrb1Bpjef8OYZy3fTFUxLdW5BPP0ZqxndLYvKE9aPZfDYBCFTjAXqTbigNwLHMuk0qpkHzzAZ1lU9sLm3A+oCc1i+f5Ma3K4IyRSutwtduEL3lE4rzesM0VCkeAMRaoMDQR06o6GWvi+P08zgmW4/HATLm4Wv64XYfQ+jMLwnxfVi2BkAq39efBhubycjL9lrhKne3FvjDb/fywSZKly+6QYC7oE5DqeWWV5+jN162Euota7EHC7PWtIGiNPE6V90h1Bq82CDm+J8jMSyQPCeNnrUFcMsbbWa/q1eXWhe9xEh+fydtV9PY27rnz/FWyA/L5ef7m4sOttgZzpfgm79csZRBAcF0GCqaxzDpy2KGgGzbZuCafaFWEIoMqE1CFjYUOJ2y+ri9EZDG5oRnyvGhk71fTb/jMW2pzE44kYC5t5rmK043iG3FYyzlAsfTsstckhgoy5oigInp6efOnMvjaHoPel4NPq4/0fj/c3Sz/0My5ye/ERDXX0Fn7oh/ao0sSFLCexHsYJ75RKL3Nrzsq//unre2RHOahyqZz8XAZNX/0NHBcuhKv/sAxs1GjcG1sPMk1swU2zl4R/mbxt7fGPGs0Jos3Wg6M0Su5tgzYNJIrscwJRKnPCN1L45Wuv0XfiNb6DFEsrxKPMa/sGHnzH0/Rr7aYvQ5mgcRw6820cY8UTx4tlYb/NozAf7tfQtv8CQz/UmA==
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get chunk details"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/default/chunks/{chunk_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a specific chunk by its ID
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"chunk_id","in":"path","required":true,"schema":{"type":"string","title":"Chunk Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"chunk_id":{"type":"string","title":"Chunk Id"},"document_id":{"type":"string","title":"Document Id"},"bank_id":{"type":"string","title":"Bank Id"},"chunk_index":{"type":"integer","title":"Chunk Index"},"chunk_text":{"type":"string","title":"Chunk Text"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["chunk_id","document_id","bank_id","chunk_index","chunk_text","created_at"],"title":"ChunkResponse","description":"Response model for get chunk endpoint.","example":{"bank_id":"user123","chunk_id":"user123_session_1_0","chunk_index":0,"chunk_text":"This is the first chunk of the document...","created_at":"2024-01-15T10:30:00Z","document_id":"session_1"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

10
hindsight-docs/docs/api-reference/endpoints/get-document.api.mdx
View file

@ -5,9 +5,9 @@ description: "Get a specific document including its original text"
sidebar_label: "Get document details"
hide_title: true
hide_table_of_contents: true
api: eJy9V01v2zgQ/SsEe9kNFH+1vejmTZM0QLstGqeHTQJjQo0lNhSpkiMnruH/vhhKsuW6SYtisb5EombezDy+4TBrSZAHmV7LN07VJVoK8jaRGQbldUXaWZnKcyQBIlSo9EIrkbWWQltl6kzbXGgKwnmdawtGED6STKSr0AMjXGQylTnSvHOUiazAQ4mEnmOvpYUSZSohR0tznclEag5cARUykR6/1tpjJlPyNSYyqAJLkOla0qpiv0Be21wmkjQZXpgykLjI5GaTbNG78P9FgI6tJsYtQ4TK2YCBvSajEf/ZZ/GyVgpDWNRGfGqNZSKVs8SUpGsJVWW0ipQNvwT2WfcyqTwTSrqJoLPnsuOkkh2bv0RUIrsNnMcNfMbpQ7fTMzbcbIuYFxCKWIldfVjEjd2H4M1oV2xtjGTiOtCTBkO8ZQzG9AiE2RyeTeWksRLTmEddZb/gc9VYtT4lls6v5rXVNFeutn1XbQlz9D3f99FaXFlN4iRabzZJZ+7uvqCiPT1dyyi2nrD3Wf6Ou72y9+r5UaK3h3rsKWtffd0HUboMjVg4L3KkXS+jzSqnLQ1kIvERyoph1z0NyTqgH09efp9yKuFOteu9LZOT0eTV8Wh8PH49G4/Sl6N0NPqH246hAoagnZ2Pf1hWOn59IEZ5Vhuzy5YXRYEeB4PBPk9PBN7wL5GvJpPDxvwMRmex7cSp987/fldmSKBN7E/CMhwaGKf2vv5Co3Qa3NzuhAbew6qnyneuSTDqOeTPif89hgA5yi3Y06aRDDHjrz8TOdfVhG7tetLc0duw+3QZbxr6fhSsM3k7m308AGz2tkQqXDtq4oQhFucQKj1cjodRyGG47gS9GXZiCsN1bzJs4mhYuEjM3iHZtv7048VBc93YqSAsK+fBHAcswZJWolG2CKtAWMaOm16IJg9BBZAI5DyGRHgkr3HJj2Az4RGCs0G4JfoGRGMY3Ngb++KFOEOg2mPg1yNxdPQXkCq63C7Jecjx6CiNjyjK2pCuDG5hBC4WWmm0ZFbiQVMhoCZXAue7AEUCH8mD4roa/MuumksErwqGPtMxSYNLsLRDrgPfBCynB0YYsHkNOYqvNfLnBu2MQ7CixJk2hCy4mGzEFqC8C0E8OG+ymA0TErlvMmr5cZW2/CYC8jWC0Kwa9Fmh7b04bU8yBj5Hy5cQFLGhH6kGI8CGB/RB3EHATDjbhtAZWtK0iiG6ohrccw9VIT7rUIPR36LyGPzCEkaultjtdR4tl33LBmJ7X5h5UPdt2fG5iQeWuWpRtspsdqiuAnoSoa4q56nVwdSrQhMqFgMvzQrslFYHDOmNPWZGWlGKd9reB4554qxF1du2qETwKJRxAYW2gnSJjft28w/cO5GDMSsRdKkN+B5r7Hza0PmTyFwnn7zE+UOJIu7CFuSy8gjxijllove4N0bHnSMPS/QBmqnWctj2FJgbK9pfe66Diud6eynsOidSx2eT0Qp5gO5MphWoAsVkMOJR441MZUFUhXQ4fHh4GED8PHA+H7a+Yfju4uT078vT48lgNCioNAzMOTbHxXgwGox4qXKBSrC9WOf9mdyMk/D9cbPejaffvJq3pyu/DSsDOg6OWNm6PTevJVRaJnI57m4vnEbau8dsRcrr/av1bSILF4gx1mtusitvNhte5qNgJdPr20QuwWu449P1ei0zHfg5k+kCTMBnyv3jUzt0/hRPldHNFsuTZQmm5jeZyHtc9f/D4An7P8btExQneYGQoY/lNxZTpbCinu/BxYNvy9shd346k5vNv8fyvSg=
api: eJy9VsFu2zgQ/RViTruAIslue9Etm2bTAO22aJw9rGEYtDSW2FCkSlJODUH/XgwlWXKceINisb7IImfezLx5Q6qBDG1qROWEVpDADTrGma0wFVuRskyndYnKMaFSWWdC5Uw4y7QRuVBcMoc/HASgKzScEG4zSCBHtx4cIYCKG16iQ2MhWTageImQwIarh7XIIABBcSvuCgjA4PdaGMwgcabGAGxaYMkhacDtK3KzzgiVQwBOOEkLf3D1wG4zaNvggD0E/y/w3w8M+BgrgrCVVhYtec3jmB7HHN7VaYrWbmvJvvbGEECqlSNCkgZ4VUmResKib5Z8mkkmlSE6negiiOxcdpRUcODyNTQFMDRv7Zt3xufz0OUFGbaHEtYFt4WvQ+0/b31TjyGoFf2KqqUEom0Aveow2AfCIEyD3GG25mdTueqs2KXPo66yV/jcd1a9T4mlNvt1rYRbp7pWU1ehHOZoJr6fvDW7V8KxK2/dtsFgrjffMHVHalqCl9oo6mOSn1B3VPVROc/luToV40RWx9IbNlipM5Rsqw3L0Y1jjCqrtFAuhADwBy8rgm1GAUFt0czmb55mnADfpP36pGEwj+dvL+LZxezdYhYnb+Ikjv+hkSMoi9YKrdazZ6tKZu9OpAh/1lKOydIiK9BgGIbHNL0QuKVfAG/n89Oh/JtLkfmRY9fGaPPrE5mh40L62XRY2lMDqdOj3VeMyaDAdjXKjBvD9xNNftRdgl7NNj8n/U9oLc8RDmAvm3oy2IJ2/03iVFcXurebKHOkt2P35TLed/Q9F2ww+bBYfDkB7Hpboit0f8n4u8WROKPdLMpwy2vpItKyjZpe0m00yMlGzeReaP3FsNWemiGsUJkVeeEYJcAuv9yezNew4SfrYN9riadeS/0l1B8hd3vrsCQ+pEiRZnY0uax4WiCbhzHJ20hIoHCuskkUPT4+htxvh9rkUe9ro4+3V9d/3V1fzMM4LFwpCXiHxnbpzcI4jGmp0taVXE1i3UyPgU7C9ml5zTgSv/gh0HeU3qJKcuHF6itr+l4tYTfzcX23+jOTMknGw/PQMlqeXuarAAptHaE0zYZbvDeybWn5e41mD8lyFcCOG8E31NFlA5mw9D+DZMulxTMF//a1l/rv7KVCBkUr0vOOy5reIIAH3E++aGis/8ewU3788VEgz9D46juLyzTFyk18T047uqAPk3VzvYC2/Qme42vU
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/documents/{document_id}"}
path={"/v1/default/banks/{bank_id}/documents/{document_id}"}
context={"endpoint"}
>
@ -47,7 +47,7 @@ Get a specific document including its original text
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}]}
>
</ParamsDetails>
@ -62,7 +62,7 @@ Get a specific document including its original text
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"agent_id":{"type":"string","title":"bank ID"},"original_text":{"type":"string","title":"Original Text"},"content_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Hash"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"},"memory_unit_count":{"type":"integer","title":"Memory Unit Count"}},"type":"object","required":["id","agent_id","original_text","content_hash","created_at","updated_at","memory_unit_count"],"title":"DocumentResponse","description":"Response model for get document endpoint.","example":{"agent_id":"user123","content_hash":"abc123","created_at":"2024-01-15T10:30:00Z","id":"session_1","memory_unit_count":15,"original_text":"Full document text here...","updated_at":"2024-01-15T10:30:00Z"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"bank_id":{"type":"string","title":"Bank Id"},"original_text":{"type":"string","title":"Original Text"},"content_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Hash"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"},"memory_unit_count":{"type":"integer","title":"Memory Unit Count"}},"type":"object","required":["id","bank_id","original_text","content_hash","created_at","updated_at","memory_unit_count"],"title":"DocumentResponse","description":"Response model for get document endpoint.","example":{"bank_id":"user123","content_hash":"abc123","created_at":"2024-01-15T10:30:00Z","id":"session_1","memory_unit_count":15,"original_text":"Full document text here...","updated_at":"2024-01-15T10:30:00Z"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/get-entity.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-entity
title: "Get entity details"
description: "Get detailed information about an entity including observations (mental model)."
sidebar_label: "Get entity details"
hide_title: true
hide_table_of_contents: true
api: eJy9Vl1v2zYU/SvEfWoB2ZIcJ930lmVZlqFpgsbbwwLDoKVrmw1FqiTl1BD034tLSbFsz+7QffjFNnl57tc5l6wgQ5saUTihFSRwg45l6LiQmDGhFtrknLYYn+vSMa4YKifchgmVyjITasn03KJZeyvL3uSoHJcs1xnKt0MIQBdo/OZtBgks0c0aBAig4Ibn6NBYSJ4qUDxHSGDO1fNMZBCAoIgK7lYQgMHPpTCYQeJMiQHYdIU5h6QCtynomHVGqCUE4ISTtPATV8/sNoO6Dl6xG9f/Bvp1UwaPPyUAW2hl0dKZURTR125lH8s0RWsXpWQfW2MIINXKoXJkzotCitSXKvxk6UzVi6MwVEgnGg8iOxUbBRVAypVWIuVy1iR/3P6qs2QfyLIOgLootJqlumyCa48K5XCJpnf2rrFkV96yDmAhjHUzi+gT4Gpzv/Dd3XVOPWlXVCklUA07yF8IgT0SQh2A5P8Q7j3voeXoeMYd3wXjWSYoCy4femVuqNDC6vknTN1JR3cddh1AXxS+YQ5ze9hHh1/cqc5MaH/bD8xm3H1vHe46DHbpSBR7mfVF8NQENt2n+/02qx6Hd3l+qfoTYX9uDGHrmBvDN71k7/s1+1aAXsJ7FN/n7V4bDtL52Q+6o5l0G80wYwttuuHXTEiGKiu0UI7GHH7heSG9zPaFB7/plYJdZcAoGo0HUTyIzydxlJxFSRT9SUOJhmQ8OsPx+cW7Af7w43wQj7KzAR+fXwzGo4uLeBy/G0dRBDvKaOFGgyiexOMk6uD2dByf7zPzqdrj1rHAGqb6VNiLNs+WccdutF5KhHpa0yeA8Wh0OPj+4FJkDRmujdHm+6deU/YTcpI63dn9GzLpJlo9PU7M97oJ0CvRLk8J9g6t5UvcsvzEDULFYBPa/RbZKa/GdWvXo/K2vE11j6fR0P0vnXUmv04mDweATW9zdCvdXuH+7nYrSCBcx2GGC15KF9LFbcOqvb/r0ItFoA2r12u39vfuQvu6dD6FyqxYrhwj7+zy4fZAid2G1+CrfUsknnoitVq7w1ybDXvcWIe5vz9EiqTurcllwdMVstGQRFQaCQmsnCtsEoYvLy9D7reH2izD9qwN399eXX94vB6MhtFw5XJJwGs0tgkvHkbDiJYKbV3OVc8Xvad2hobdT67aquE/eH21jSb1hoXkwnPY51y1LXyCdexj8k2EwL+/KMpk+xDrOkmr2yfUNICVto4gqmrOLf5uZF3T8ucSzQaSp2kAa24En1OjnyrIhKXfGSQLLi2eqMSbjy3937JjWXQsV8TxNZcl/YMAnnHTe0WS1P9Ht9vq+IGyQp6h8bk3+5dpioXrnTyYf3Rlv2rt5noCdf0V9qXxZA==
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get entity details"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/default/banks/{bank_id}/entities/{entity_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get detailed information about an entity including observations (mental model).
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"canonical_name":{"type":"string","title":"Canonical Name"},"mention_count":{"type":"integer","title":"Mention Count"},"first_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Seen"},"last_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Seen"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"observations":{"items":{"properties":{"text":{"type":"string","title":"Text"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"}},"type":"object","required":["text"],"title":"EntityObservationResponse","description":"An observation about an entity."},"type":"array","title":"Observations"}},"type":"object","required":["id","canonical_name","mention_count","observations"],"title":"EntityDetailResponse","description":"Response model for entity detail endpoint.","example":{"canonical_name":"John","first_seen":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","last_seen":"2024-02-01T14:00:00Z","mention_count":15,"observations":[{"mentioned_at":"2024-01-15T10:30:00Z","text":"John works at Google"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

12
hindsight-docs/docs/api-reference/endpoints/get-graph.api.mdx
View file

@ -1,13 +1,13 @@
---
id: get-graph
title: "Get memory graph data"
description: "Retrieve graph data for visualization, optionally filtered by fact_type (world/agent/opinion). Limited to 1000 most recent items."
description: "Retrieve graph data for visualization, optionally filtered by type (world/experience/opinion). Limited to 1000 most recent items."
sidebar_label: "Get memory graph data"
hide_title: true
hide_table_of_contents: true
api: eJzNV21v20YS/iuD7ZfEoCVZTYEDv6mN4zOQOoGt9oDahjEmR+TWy112dyhFJ+i/H2a5lKk4boHiDjh9kbSceWbm2XnjTjFWQeW36lcdOjT638jaWXWfqZJC4XUb/+bqmthrWhNUHtsaSmSElfOwHqtl4KI8GrOFlTZMnkp43MIKC37gbUvwZuO8KadYkeWpa7XVzr6dwEfdaKYS2MHZbDaDxgUGTwVZBs3UhInKlGvJRzuXpcpVRfwQnVGZatFjQ0xeQtkpiw2pXEUjD7pUmdISQ4sswp7+6LSnUuXsO8pUKGpqUOU7JR6qXAX22lYqU6zZyMFCgOCyVPt9dkA/xDTA/9GR3x7hr9CEIwNot59W0cVjUwKbTmxnjNrfPxv/gAXDUh7u5dhTaJ0NFARvPpvJ1/FV3XRFQSGsOgPXSVhlqnCWyXL0om2NLiKT09+D6OxGPrZeeGbdW7Cu7H/EW4jaZan7S/48kuypTDG4x9+pYLU/HKD3uB0RehVR95misvofwJ9HVHmOj4YevNv8920sBRquBVqEHKN56KzmMEokbZkq8mMtkYNfotx+/7W1ce7cJuoHjo6COTY4SpYLKYj3yDi6+a8LuX8AjSvJxBoelTTZsnXaspQbfcGmFdTdcE23O7XyrlG5OosuqFzN1SGIQA1a1oXK1IZ0VbPKZ5N/SM6mJLrdKV0mZYOPZKS0jC4INs4/BUCGC+cqQ8+YsVvE8oia85Hmj+4RNlKXtX5K5Xqkc398/be7vgS+sMrVv5x/Am1XTuhBFq35bP7udHZ2evYDnM3y72dCgGXdp0Zy883n8+ubT1dvs+QnvPl0fbG4uvxtsbz8dPVWGoF4iY/F2fz7dz9MJkJjMvntQKOX49yZ7+WTqXfz+cvK/hWNLmPdwrn3zv/9si6JUZujojgWMK44Lpm/7lxDtu/vX6+aj653UGqmCdWfNd2fKQSs6LkEXxeNZAw98s+LSuLqTSe5UfE809uz+3oY73v6vmVsEPnncvn5BWB/tw1x7dIIi8OLa5WrKbZ6uj7rR2OY7obptZ8OUy4mrNBwNJZ+psb5LSw+X76o9Tu7AKamdR7N6VCe0PQKYRuYmtgAFpfQWwWukSGw8xQy8GnmhwzQluAJg7MB3Jp8D6IpTO7snf3uO/hAyJ2nIH9P4OTkR+SiHny7YeexopOTPP4kaDrDujV0gAFarXShybLZwkZzDdixa1D8lUEL9IU9FhJXj38zRHND6ItaoD/o6KShNVp+Ru6CthVYcQ8NGLRVhxWBTGst/graYcbCh7i1aFtFZyM2YOFdCBD7SvRGCInc9x4lftI2EyCQ7CNMZtujL2ttn+A8tVYBviArqwxBakkdGkAbNuQDPGKgEpxNJnQZ29A2mhiC6nFjs4ejxU3ALy1T5GpNw133Hf5oV+sh3ruia8TM0mPxlMKOv3t7aIWrhFIm4dDfUNcG8gyha1vnOeXBwhe1ZiokGeRoWdOQaV2gkN/ZU2EkJSV81PYpiM2fnLVUjK4tZiJ6gsK4QKAtsG6oVz9c/gv1IcnjBhp0ow36EWuifN7T+ReWJU7psyz+Y0MwDIPkQesJS0mshRB9xL0xOt4ce1yTD9gP2cRhqik0dxbSJ3VxLGIXT9vlUDmROulEMj5knj+LLFosaoL5RGZV52Um1sxtyKfTzWYzwfh44nw1Tbph+vHyp/Orm/PT+WQ2qbkxAiw+9u3ibDKbzOSodYEbtCNbF8THuSTbwtf9Zvc8jf4v3hdSa5YCm7YGdZw6kahdarq3ClutMrWWlaRvgSpT+ejFoe+995mqXWBR2O2kQH/xZr+X437pl7lY6iDrxvPa/0Tbr14T1mg68SiO/TV6LQrfVn6V2DfXaZq9hddCHIaW3Y5tDg4dgotzuiYsyUcf+seLoqCWR4ov1gpx/jDCLs6Xar//Dw9s58g=
api: eJzNVm1r4zgQ/itiPrXg2o63C4e/ZW9DL9BtS5q9gwulKPYk1kaWvJKSNGv834+Rncbuyx4cd3D9kiLPyzPPzDNSDTnazIjKCa0ghRk6I3CHbG14VbCcO85W2rCdsFsuxQ9OdgHT3p5LeWArIR0azNnywNyhQna210bmET5VaASqDCNdCSW0Og/ZtSiFw5w5zUZxHLNSW8cMZqgcEw5LG0IAukLj80xzSGGN7tGDgQAqbniJDo2FdFGD4iVCCkuuNo8ihwAElVBxR7YGv2+FwRxSZ7YYgM0KLDmkNRBKSME6I9QaAnDCSTr4xNWGTXNomuA5trftAn/fojkMIq+4tIPQXB1uVx7bMAlF7E7UVkpoHk5p53Te0IlBW2ll0VKoJI7pZ9ie+22WobWrrWSzzhgCyLRyqJwHUFVSZJ696Jsln7oHrzLErRNtBqXz9h/PvPfOc9E29q5n2fLXwdfLb5g5aJ4PuDH80GPxxkdtAsB8/R+En/io9J0vJT4avf/3c8wpNJtRaDLSjsvHrRLO9qZHKIdrNH0vsmNfvV3TvMzWH5tFR/2Ro0Exw4S9ObkiEXzmjvc6/1K87QdW6hyl121PxqjySgvlSGL4xMuKotbHNi1qWBldQgojDwFSSOC5CIslV05kEMAexbpwkMbhLzSz3RAtahB55yz5EiWkMJYiQ7bXZmMZd+xK67XEU0y/JrwyvGfS8/ykl2xPO6EQm06jA5+HYfsXdSuBJwcp/KHNhgm10kQPd+SVxMnlRTy6GH1kozj9EBMByol2NDqYZ3eT2f3tzXnQ4WRnt7Or8c30z/F8entzTjuAUPJlNko+XH4MQ6KxS/l2oR5lf3aShv4CuEyS18r+nUuRe92yiTHa/HNZ5+i4kANRDA2kzoaS+fuldZz25uF91VzrFiBpprTrn23aL2gtX+NJgu+bejJYtyN/Liqqq03d2fXEc6K3Zff9Mj639L2V7Gjy23x+9ypg29sSXaG7a8tfWK6AFKLdKMpxxbfSRXRb2ajuLq0mOt5tfmSJiGMSoXJLUmOUjo3vpq/0fvzglf5s300Oz/zkdPfYFyy1ObD7g3VYUvU0srRDTibjimcFsiQkfWwN6bBwrrJpFO33+5D7z6E266jztdH19NfJzf3kIgnjsHClpMA7NLaFNwrjMKajSltXctXLdYWOlS2k04Z6WV99UsD/4l3SjQOJPqokF37SPVF11+gF7Ea+Ct9qCPzThFZ6enqjtP1+CKDQ1pFLXS+5xa9GNg0dt68MUmMuLC250ztjg4fTk2TH5Zbg+D2z40aQ7dt+77J6Nuvkc87eq++oEnXo5zxiOZbl90KBPEfjIbRfx1mGlev5vVpjhP1ZMleTOTTNX3BHkSA=
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/graph"}
path={"/v1/default/banks/{bank_id}/graph"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
Retrieve graph data for visualization, optionally filtered by fact_type (world/agent/opinion). Limited to 1000 most recent items.
Retrieve graph data for visualization, optionally filtered by type (world/experience/opinion). Limited to 1000 most recent items.
<Heading
id={"request"}
@ -47,7 +47,7 @@ Retrieve graph data for visualization, optionally filtered by fact_type (world/a
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"fact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fact Type"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}}]}
>
</ParamsDetails>

63
hindsight-docs/docs/api-reference/endpoints/health-endpoint-health-get.api.mdx Normal file
View file

@ -0,0 +1,63 @@
---
id: health-endpoint-health-get
title: "Health check endpoint"
description: "Checks the health of the API and database connection"
sidebar_label: "Health check endpoint"
hide_title: true
hide_table_of_contents: true
api: eJydUk1v2zAM/SsCz5rt5ehbUQRLgLUoluxkBIUqM5ZaW9IkOplh+L8PtN31Y7f5Iovi43vk4wikmgRlBXfeWfLRugZOEmpMOtpA1jso4dagfkmCDAqDqiUj/Hm+3TzshXK1qBWpJ5VQaO8c6hkmwQeMiv/3NZSwIB/R1cFbR4/rvUECCRFT8C5hgnKETVHw8VHDodcaUzr3rfixJoME7R2hI05XIbRWz3z5c2LMCEkb7BSU48SfhA7JeBazsAZFBkrIFykgwbqzZxxZahFK2FlXJ9sYErvj8YHbhc+zeX0QZx/F3/xVmtKzNKc6rnaHnY+DOAyJsINJQms1ch9vKTdBaYNikxUgoY8tz40opDLPr9drpubnzMcmX7Ep/76/3d4ftl82WZEZ6loufMGYFnlfsyIrOBR8ok65d1y7xUrN5opXWz73N76N+H/XgIbAdIS/KQ+tso7lzL2NqwPVuhy8ecYn4sg4cqWfsZ0mDv/qMQ5QVicJFxWtemJ/qtMkGVpjhLIa4QUHnqHWGLiRi2p7Zv5nM6bTu1X4tj3CNP0BgNwIYQ==
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Health check endpoint"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/health"}
context={"endpoint"}
>
</MethodEndpoint>
Checks the health of the API and database connection
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
>
</StatusCodes>

76
hindsight-docs/docs/api-reference/endpoints/hindsight-api.info.mdx
View file

@ -1,76 +0,0 @@
---
id: hindsight-api
title: "Hindsight Memory API"
description: "A temporal-semantic memory system for AI memory banks that stores, retrieves, and reasons over memories."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---
import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 1.0.0"}
>
</span>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Hindsight Memory API"}
>
</Heading>
A temporal-semantic memory system for AI memory banks that stores, retrieves, and reasons over memories.
## Features
* **Batch Memory Storage**: Store multiple memories efficiently with automatic fact extraction
* **Semantic Search**: Find relevant memories using natural language queries
* **Fact Type Filtering**: Search across world facts, agent actions, and opinions separately
* **Think Endpoint**: Generate contextual answers based on memory bank identity and memories
* **Graph Visualization**: Interactive memory graph visualization
* **Document Tracking**: Track and manage memory documents with upsert support
## Architecture
The system uses:
- **Temporal Links**: Connect memories that are close in time
- **Semantic Links**: Connect semantically similar memories
- **Entity Links**: Connect memories that mention the same entities
- **Spreading Activation**: Intelligent traversal for memory retrieval
<div
style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
Contact
</h3><span>
Memory System:
</span>
</div><div
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
License
</h3><a
href={"https://www.apache.org/licenses/LICENSE-2.0.html"}
>
Apache 2.0
</a>
</div>

57
hindsight-docs/docs/api-reference/endpoints/hindsight-http-api.info.mdx Normal file
View file

@ -0,0 +1,57 @@
---
id: hindsight-http-api
title: "Hindsight HTTP API"
description: "HTTP API for Hindsight"
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---
import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 1.0.0"}
>
</span>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Hindsight HTTP API"}
>
</Heading>
HTTP API for Hindsight
<div
style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
Contact
</h3><span>
Memory System:
</span>
</div><div
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
License
</h3><a
href={"https://www.apache.org/licenses/LICENSE-2.0.html"}
>
Apache 2.0
</a>
</div>

12
hindsight-docs/docs/api-reference/endpoints/list-banks.api.mdx
View file

@ -1,13 +1,13 @@
---
id: list-banks
title: "List all memory banks"
description: "Get a list of all memory banks with their profiles"
description: "Get a list of all agents with their profiles"
sidebar_label: "List all memory banks"
hide_title: true
hide_table_of_contents: true
api: eJylV9ty2zYQ/RUM8tJ6aIly4rTDN9m1U83kNrXSh9oez5pckYhBAAFAyaxG/95ZkJQoyrm5fjFE7O5Z7OUssOYecseTaz7NUXn2DhTkWKLy/DbiGbrUCuOFVjzhb9AzYFI4z/SCgZQMSMexlfAF8wUKy4zVCyHR8YhrgxZIdZbxhJPaXSPPI27RGa0cOp6s+Ukc0799sKsqTdG5RSXZX60wj3iqlSffkjUHY6RIA8D4syOdNXdpgSXQyliC96JBaHGTNRceS/cVgTuR0drXBnnCnbdC5TziXnhJH5oAzTK+ibiCEr8l+572NxE3aJ1WIIWvD0G1QaXQuZ4hVZX3aHnES3gUZVXyZBLxUqhmHe8APnS6wyR1G8xrho8GrUCVIvslPp78Sh6lWrlUoPJCV+656OcHRoZuHEjsPMBHb2GJ1okmaT8LftHXH+L2N3eQkFtEuJf43ANP9wwMQfd2d6gKK6u9SIUrn4P5vqc+ROzt7fDuBbg75y2q3BfPQTwT4NhVZ2CI+adeMeetVrmsWa+wmVALWVGVOaaNUEKrbRA2UeeEvv+MqQ+t/6USFjPiHL2r4sO6HFTKMIv78R2e/nZ3qo87V+cWhD/MX0+C+SDC7sFhxrRiZyJnl2KJrNQZylHwCkojsaGNvbqKR78dZCF8e6Lp4tHrYSvEo9NB0cSjl1GPJuLR7xTRe0gfcqsr9U26OttJUdtbBI/ZHTTcqeoPC55cD7U3Ua9opOSbXhjPGwts6sleZbL/ae9TYyHY+06ZbNm5Jd59Xt0LyO2Ar98K52ceDzuoYfMwzGgmNDOsnV7MVWUJth7xnWNgLdTDaeB+zHX3pFu9sbbvWrfRlBxbaBv8FCrvDd2DSmwm3HV/lvHKoZ2cvNwPUcJnDEoGzOmFX4FFhioXCgNF9OuEn8Qnr47jyfHkdD6Jk5dxEsf/dDlI+FSKdJiLp3ri9ImeOP1KT5z+SE+c7vfE6aAcd26/nk9eJSeN25vbTfiLeIm+0BSGHClbBsglPgYjxsvJeHtFEWqhQ3/tjf93WGpbs+nH2UHabtSUeSyNtiCPHZagvEhZ2Si42lGVUS6ns+7e5AvwzHlt0UXMorcCl7QElTGL4IhI9RJtY0SgG92oG/XiBbtE8JVFRz+P2NHRGfi06Hy78tpCjkdHSVgiKyvphZG4NcNwsRAh9rJuCh8qr0sgfxeQehZykNK5GvtX3WmuEGxakOlLEZyUuATld5YrR2WqyD2QTILKK8iRfanoIuIaa5cEMa8NskshPRJTBGeDbQap1c6xlbYyC95QQELsG4/a+GwnjUMDFjzKurE+L4R6YBcqM1ooT4bfoKKbKLJwe3z0FUgGyq3Q9ni+gRAZFaSvA0R3qMbuGwumYH8LV4EU/4Z7JxmfKY8hVkvscp0HyWVfsjHxh04rulqzuYX0oT12WDd44e7dWcla4fZ6XRmH1jNXGaOtb+tgatNCeEypGOjTvMCu0iqHLrlRxxSRtijZW6EeHGGea6Uw7aUtVCJRQSq1QyYU86LERn2b/AP1rshBypo5UQoJthc1Ur5owvkd5DLQgKI3BHNQEiN54bdGroxFyKiwphTovdhLKULmWtKAhi/bGLY9BfJGsfavfURAGgZXS2Vd54TQEekTtRE170SmBtIC2cko5hGvrOQJL7w3LhmPV6vVCML2SNt83Oq68dvZ+cX7q4vjk1E8KnwpyfCW2PhkFI/i8EbQzpegelg0HXpUP2Sa9e4Z9LNvsnZUUReMjQShwiyn06xbIrzmYASP+HISblzd9Cq087S5XlPHfLJys6HP1Nc1T65vI74EK4j26dcm4gVChjYMpAesKYBpioYIdwmyChN1+ICj28GWnN9czPlm8x9AEQw1
api: eJylVttu20YQ/ZXFPDUALVFy3AcCeXBTIxbgpkGtvFQwjBU5EjfeC7M7lCwI/PdilpQoykZz04uInduZ2TOH3EOBIfeqIuUsZPABSUihVSDhVkJqLeQaLQWxVVQKKlF5UXm3UhoDJOAq9JJDZwVkwGGPS2mf2OQxVM4GDJDtYZqm/DesdV/nOYawqrX4p3OGBHJnCS2xu6wqrfKYf/wlcMweQl6ikfxUea5Oqq3Qls32oAhNeN3+qAp+pF2FkEEgr+waEiBFmg/+kPZJzApoErDS4P+5fmR7k0ChQuWCahs6LxmesCKVq2BOUilLuEYPCRj5rExtILtKwCjbPk/6Gvd9eHI2uVu3FV12qcUmCPJ1IGXX4rfJu8NzIq7eHZ3eMFqtCL3UPwvorg9/DVCXXe8EOcFZfeWRhLIr5028REa30vislhoZXRcRsaGpJJW7nwJ208W+hsrUecmAcmeDKtALNI7NUovItGdiVAWSzEssGFWLBEnlb6BpkgMct/yCOUVif62VxwKyxekVD8bb9/PQw/yzJ8vcS0XhBeATD0HRRVAp4wx1jTZHUXJLaJxXGIT0KHi4WAhpi37mWIwYwbM0lY40Pg73ckiCy2RA0ktudynzp7V3tf3Grhy9mgRyj5KweJTt2trd3yvIFufRTXI8sbXW0JzM5n2bQVwT56ur4hfzfW4zxHzfuMODMnRbP1zqwTwehlpxpwLNCF9uQxSSqKEsRq10dqIpQm2M9LsR9Kik93J3pkPhu2CH1yCdaOkQ1sEgjCtQM3MiSJYNFvqY8Iw4naou9gNawExII6QIbkVbJiHatbIYd/Wos1AH9JPpJQzpAdN0+vYinVxMruaTNLtMszT9F14o6Xcz9qDVcK1Vzj2fcqcv9vt88jabtsWahyb+EjBIpWOsa+TxcknIYLyZjAtcyVrT+PA2YxWL+9AN+1bZIqh1SeJ2Pv8krj/NXqpPZ4iDPvp3bziZR2p32P/ijd6J+11gOkWlzpGvsHe5rligxHSUco9eQwYlURWy8Xi73Y5kNI+cX4+72DC+m72/+Xh/czEdpaOSjObEG/ShhTcZpaOUjyoXyEh7UotZFClhWlyHIQz62/dv6h/9auhozeI7rrRUNu4897Tv7mABm0ksGG+ho1Vke+kCsX2/X8qAn71uGj7+WqPfQbZ4SGAjvZJLvqXFQ5NAibJAHzn8hDueZJ5jxTk3Utdx/84/M1hIjtT4cDOHpvkPDiMe0Q==
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks"}
path={"/v1/default/banks"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
Get a list of all memory banks with their profiles
Get a list of all agents with their profiles
<ParamsDetails
parameters={undefined}
@ -54,7 +54,7 @@ Get a list of all memory banks with their profiles
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"memory banks":{"items":{"properties":{"agent_id":{"type":"string","title":"bank ID"},"name":{"type":"string","title":"Name"},"personality":{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}},"background":{"type":"string","title":"Background"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["agent_id","name","personality","background"],"title":"AgentListItem","description":"Memory bank list item with profile summary."},"type":"array","title":"Memory banks"}},"type":"object","required":["memory banks"],"title":"AgentListResponse","description":"Response model for listing all memory banks.","example":{"memory banks":[{"agent_id":"user123","background":"I am a software engineer","created_at":"2024-01-15T10:30:00Z","name":"Alice","personality":{"agreeableness":0.5,"bias_strength":0.5,"conscientiousness":0.5,"extraversion":0.5,"neuroticism":0.5,"openness":0.5},"updated_at":"2024-01-16T14:20:00Z"}]}}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"banks":{"items":{"properties":{"bank_id":{"type":"string","title":"Bank Id"},"name":{"type":"string","title":"Name"},"disposition":{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}},"background":{"type":"string","title":"Background"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["bank_id","name","disposition","background"],"title":"BankListItem","description":"Bank list item with profile summary."},"type":"array","title":"Banks"}},"type":"object","required":["banks"],"title":"BankListResponse","description":"Response model for listing all banks.","example":{"banks":[{"background":"I am a software engineer","bank_id":"user123","created_at":"2024-01-15T10:30:00Z","disposition":{"empathy":3,"literalism":3,"skepticism":3},"name":"Alice","updated_at":"2024-01-16T14:20:00Z"}]}}}}}}}
>
</StatusCodes>

10
hindsight-docs/docs/api-reference/endpoints/list-documents.api.mdx
View file

@ -5,9 +5,9 @@ description: "List documents with pagination and optional search. Documents are
sidebar_label: "List documents"
hide_title: true
hide_table_of_contents: true
api: eJzFV01z2zYQ/SsY5NJ6aIlS4gtvamKnnnGaD6s51PZo1uRKRAwCDLCUrWr03zsLghQVx3Hb6Ux1MQku3i7ePuyut5Jg5WV2Jd/YvKnQkJc3iSzQ507VpKyRmbxQnkTRfRf3ikpRw0oZYAMBphA22IIWHsHl5Uj0cAIcCipReNu4HEVuDaEhsXS2EvelyktRYWXdRjRGRXN8IAc5YTGSibQ1uuDovJCZ1MrToo9FJrIGBxUSOj7FVhqoUGYSVmhooQqZSMVHqIFKmUiHXxvlsJAZuQYT6fMSK5DZVtKm5n2enDIrmUhSpHlhxkDivJC7XdKjf+1gvzboNge4S9D+ABjM5v0yhHboguHiimm0lrubvdOPB960qhT9A48RVRnCFTrJ2VxCo0lmkzTdO7kIsENHdrn0+N94Gvh536Lu+IAOfW2NR8+7p2nKfw61dtnkOXq/bLT4FI1lIqNoAp91rVUeBDH+4nnPdhBR7VgupFoPirA6fICiUK1SPwwsWzHE09jbL5iT3PUL4BxsBpI4D2D83RLo7/LQmc6DxS6JOfyRaUxH0mXhR7Y9pd8GPczWVTx1F2fSCyl6uBk699Tf2AHvh7npPojKFqjF0jqhD0sDmqK2yhDfW3yAqmb0nv6r7f5eZrLx6CbTl/vsLkrwJfN9m8d1h0BYLIBkJqfp9NVxOjmenMwnafYyzdL0D5YqQ3n0XlmzmMhEtsVkwcVkkduGRTM5SSThAy00mhWVMjt5NU0T2dTFM/As2Zi5cHW61KR97k/SHf8S+Wo6fSzmz6BV0RbJU+es+/dKLpBA6QMpHxpomx8K/fmy0+lqd/O01i9sGyALs/KrH1XKd+g9rHB/cZ42DWSIOX99TsN8rtZ1tBuodk9vy+7Tx3jT0vc9Z53Jr/P5h0eAbW4rpNKyzlahOoZekskx1Gq8noyDpP1420l7Nx62J2WWNlBx0E/etR1v9uH80SW7NjNBWNXWgT72WIEhlXct0m88YRVu3uxctJ4FlUDCk3XoE+GQnMI1P3JfdgjeGi/sGl0LotCPrs21efFCnCFQ49Dz65E4OvoFKC+72C7JOljh0VEWHlFUjSZVa+xhBC6XKldoSG/aoQAashVwvEvIqWvjykb8y+40l2FIYOgzFYLUuAZDe+TGK7MShsMDLTSYVQMrFNySFMfLaGfsgjUkzpQmZImFYAO2gNxZ78W9dboI0TAhgfs2osiPrZXhN+GRBwlCvWnR56Uyd+I01jMGfouGB5E4wTxQA1qA8ffovLgFj4XgWSi4UAUaUrQJLrpDtbhvHdSl+Kx8A1r9GbTG4OeGMHC1xi7Xq2C5Hlq2EF2hFnMH+V08dnhu/YFhriLKN2NbU3t0JHxT19ZR1MHM5aUizFkMvDTnaa1VWuPRZ9fmmBmJohQXytx59vnaGoP5IG1BiTzA5dp6FMoIUhW22/vkP9reiRy03givKqXBDVjjzactnc945nNyrQ3TJlQoQhZ6kMvaIRQsrBkTfcC91ipkjhys0Xlou1vkMN4p0NdGxF+s5JCHSh7np+7mBOrarp8jN9K9yayGvEQxHaUykY3TMpMlUe2z8fj+/n4E4fPIutU47vXji/PXp79dnh5PR+mopCqMExxjWy4mo3SU8lJtPVVgBr4Ox/ZvC81234r+5wE/VmS+U+NagwrNJnCzjbX2SkKtZCLX3ODbqicTmQ2G/GL430tpPfGm7Zbv5e9O73a83A603BIL5eFWD0baO9zEsX4NuuFoQqN8wq6bo/6ObT9T741v+MUptv5+NE/m6adPsTP+LJ7irWuAZjP02UXTMxZ6folQoAsxtJ9neY71MNhHIwoH37fDt6dzudv9BQlO5jo=
api: eJzFVk1v4zYQ/SvEnFpAsSRvctEt7QatgWw33bg9NDAMmhpb3FCkQlJJDEH/fUGK+trESVsUqC+2ycd58/FmyAZyNEzzynIlIYNrbizJFatLlNaQJ24LUtEDl9QBCJU5UR5LBTFINSsW5OMApxqJLZAYVWuGhClpUVqy16okTwVnBSmxVPpIaskDHJ+tpsxivoAIVIXaE61yyEBwY7eDLxBBRTUt0aI2kN01IGmJkMGOyvstzyEC7iKoqC0gAo0PNdeYQ2Z1jREYVmBJIWvAHit3zFjN5QEisNwKt/ATlfdklUPbRoPth97qQ436ODO7p8LM7FJ5/Lz3js0ZnLmwImshoN2MnL/P2AQvuf0HjMEqlxYPqCGCHPe0FhayNElGkmtvdkqk9nuD/w3ThOdzZ7V1AWo0lZIGjTu9TBL3NVfabc0YGrOvBfkSwBBBkIzPZ1UJzrwc4q/GnWkmHlXaicXyjoFbLOc/aJ7zTqc3E2SnhRCN2n1FZqEdFqjW9DhRxMobc/vKUvFqHnro2iPaKNTwLWgoR9RX4S3skNLvnZ5W6y5E3fsZDUIKDJspubFDv07yPq9Nv0FKlaMge6WJmA8GlHmluLSua/GZlpWzPqT/rhm6MoPaoE6XH8bibgtqCpfuHQvrGqnFfEstZLBMludnSXqWXqzTJPuQZEnyl1OqM2XQGK7kNoUIukmydZNky1TtNJNeRGDx2W4FyoMtILs4XyYR1FX+jnmn2FA43zl9ZZKh9BdJ6z4RnC+XL7X8JxU87ybkldZK/3sh52gpFzMlzwFCsbnO3586vazazWmpX6vOQafL0hzempOf0Bh6wLFvTkN9Msja7b4nYRdXRx1wE9GO6e2yezqMj136XiPrIb+u1zcvDHa1LdEWyuns4Iejv0kyiB/TOIy72KnaxE0QdxtPbycu98onoyfiMjf8UFjiKMnlzepFn/UbvsMGfFAPZV49YWR/6i7O26OxWHaDhqHr3RFyWVFWIFkuEoig1gIyKKytTBbHT09PC+q3F0of4nDWxNern69+u706Wy6SRWFLP8EeUZvOvXSRLBK3VCljSyonXPN3wveBNaP8/+cXRVCBmwpxJSj3Ave5aUJ97+AxnVxokZ9cLqJsfFiMgW4iKJSx7ljT7KjBP7RoW7fc3aKuEXNu6E5M7tF7PIa3xCMVtfPHt+cJXD+8/w52uMhH8Mb90dyhX/fmZKV++BL68UdyKnN928njlLP3pk+YHzQF0hy1d6HbvWQMq6mvL+ai833owV+u1tC23wAZ6pY/
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/documents"}
path={"/v1/default/banks/{bank_id}/documents"}
context={"endpoint"}
>
@ -47,7 +47,7 @@ List documents with pagination and optional search. Documents are the source con
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}]}
>
</ParamsDetails>
@ -62,7 +62,7 @@ List documents with pagination and optional search. Documents are the source con
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["items","total","limit","offset"],"title":"ListDocumentsResponse","description":"Response model for list documents endpoint.","example":{"items":[{"agent_id":"user123","content_hash":"abc123","created_at":"2024-01-15T10:30:00Z","id":"session_1","memory_unit_count":15,"text_length":5420,"updated_at":"2024-01-15T10:30:00Z"}],"limit":100,"offset":0,"total":50}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["items","total","limit","offset"],"title":"ListDocumentsResponse","description":"Response model for list documents endpoint.","example":{"items":[{"bank_id":"user123","content_hash":"abc123","created_at":"2024-01-15T10:30:00Z","id":"session_1","memory_unit_count":15,"text_length":5420,"updated_at":"2024-01-15T10:30:00Z"}],"limit":100,"offset":0,"total":50}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/list-entities.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-entities
title: "List entities"
description: "List all entities (people, organizations, etc.) known by the bank, ordered by mention count."
sidebar_label: "List entities"
hide_title: true
hide_table_of_contents: true
api: eJzNVttu4zYQ/RVinnYB2bqsk231lqZpm8LZBhu3Dw2CgJbGFjcUqSWpJKqhfy+GkmLZibPbLQo0Lw7E4ZnbOcPZQI42M6JyQitIYS6sY1xKhsoJJ9CyNxXqSmLAtFlzJf7iZGkDhi6bvmV3Sj8otmyYK5AtubojuxwN5vSxJBStWKZr5aYQgK7QeIDzHFKQwrrbwREEUHHDS3RoLKTXG1C8REiBUG9FDgEIirDiroAADH6uhcEcUmdqDMBmBZYc0g24pqJr1hmh1hCAE07Shx+4umPnObRt8IQtRSncgPy5RtPsQK+4tC9hC+VwjQaCvepd8EdR1iVTdblEw/RqW0anmUFXG+UvrXgtHaRxFG3jm/tY2m/CbG8obFtpZdFSoEkU0c8u1FWdZWjtqpbsY28MAWRaOVSOzHlVSZH5BoWfLN3ZjJKvDLXP9yrdgHBY7v6zd56/1gzqQwAZV1qJjMvbrh+H7U8HS/aBLNsAem7dem692Jvh7kXPwlNv2QawEsa6W4voE+Sq+W3lCbfrnGjSf1G1lL7GA+RPhMCuCKENQPJ/CTfnI7QSHc+547tgPM8FZcHl5ajMHfd7WL38hJl71dHFgN22+9fGvL8Gr7e99uzXfIR7RpRsaHicOyyf6aI7ZqR3RnRhD8IVzNZlyU1DcwEfeVlJz4B9TsCvuiDRjJsGSZTMJlE8iY8WcZS+i9Io+pNkTFMlTt7h7Oj4/QS/+345iZP83YTPjo4ns+T4OJ7F72dRFMFO03q4ZBLFi3iWRgPcHsXio1HVuDG8GRPaq+CLZfVWLxZupMjd4g0HrNQ5SrbSppsAfT1R5ZUW3XgdlbFX5fX/vKA3Lf0FMEuS5/PqDy5F7qcROzNGm28fVjk6LuQr00rqbOf0K1Q8DJr25jAr5roL0Ovarl+bcBdoLV/70daZHDb1xWALOv0S4SivznVvN+LetrxddQ+n8WNXvpecDSa/LBaXzwC73pboCk1EWqPzr7wrIIXwPg77hzCkJ96Gm/6lb8PRTiDUSvtaDH6Eyq1YF46RR3Zyef5MMMOBl8qTfU8ennny9FK4wFKbhl01lsYWjXKRIYlwa3JS8axAlkyJ47WRkELhXGXTMHx4eJhyfzzVZh32d204Pz89+3B1Nkmm0bRwpSTgezS2Cy+eRtOIPlXaupKrka95J+in5Hfy2mzJ/1+vaX2THT66sJJceP763Dd9+67hPh5tMoHf0ijkdLuuPSVyE0ChraNbm82SW/zdyLalz93KRTLLheVLOVq6Dub+lUvWizncYTPa+u65rMnGP5H33AiK4B9G8+Zjr7a37JDTQVSqGfscghnq5cdIgTxH40PoTk+yDKtxrM+mHsX+pLCfzxbQtn8D36n4VA==
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"List entities"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/default/banks/{bank_id}/entities"}
context={"endpoint"}
>
</MethodEndpoint>
List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Maximum number of entities to return","default":100,"title":"Limit"},"description":"Maximum number of entities to return"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"id":{"type":"string","title":"Id"},"canonical_name":{"type":"string","title":"Canonical Name"},"mention_count":{"type":"integer","title":"Mention Count"},"first_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Seen"},"last_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Seen"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["id","canonical_name","mention_count"],"title":"EntityListItem","description":"Entity list item with summary.","example":{"canonical_name":"John","first_seen":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","last_seen":"2024-02-01T14:00:00Z","mention_count":15}},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"EntityListResponse","description":"Response model for entity list endpoint.","example":{"items":[{"canonical_name":"John","first_seen":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","last_seen":"2024-02-01T14:00:00Z","mention_count":15}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

14
hindsight-docs/docs/api-reference/endpoints/list-memories.api.mdx
View file

@ -1,13 +1,13 @@
---
id: list-memories
title: "List memory units"
description: "List memory units with pagination and optional full-text search. Supports filtering by fact_type."
description: "List memory units with pagination and optional full-text search. Supports filtering by type. Results are sorted by most recent first (mentioned_at DESC, then created_at DESC)."
sidebar_label: "List memory units"
hide_title: true
hide_table_of_contents: true
api: eJy9V21v2zYQ/isE96UNZFvOnG7TN69NMwNp0zVuB7QJiot0tthQpEKenHqG//twpOTITdN2wzZ/sUQd73l479xIgqWX2Xv5Aivr1uKsRgekrPHyMpEF+typmt9lJk+VJ1FFucYo8uJWUSlqWCoT9ggwhbBBHLRYNFoPCD+R8AguL4fivKlr68iLhdKETpmluFqLBeT0gdY1DmUibYc/K2QmtfL0ISAq9DKRNTiokNAx5Y00UKHMJCzR0AdVyEQq5lkDlTKRDm8a5bCQGbkGE+nzEiuQ2UYymMykJ6YgE0mKNC9MWZGYFXK7TXbad/Q69TcNuvWe/gVovwcAZn22CBT3oVhtu2IareX28g78OeQk5vyxj37zH6P+voemVaXobyC2WpUhXKKTHDALaDTJbJymdyCnQW0fyC4WHv8dpB7OWdS65QM69LU1Hj3vPkxT/tsP5/Mmz9H7RaPF61ZYJjK3htBQsGdda5WHaBx99Lxn02NUO45VUhFBEVb7D1AUKmbCq55kDMX2NPbqI+Ykt7sFcA7WvYCcBWX83RLoL9qhE50HiW3S+vBroq07ks4LX5PdmfRz0n1vvW9P3fFMdoHUIlz2wT3FWvOGS0jP8vve6T6IyhaoxcI6oe/VHzRFbZUhrhz4CaqaIXY+eL+J3vxEMpN/WHctcmtW6HxwKSMCMaXD9HAySMeD8dF8nGY/plmavmOFhlR0mpxqlaN49Or49fnZy8eJOLF2qVE8Ont9Mn05ezedz85ePpZJr1Zk8tY6HUoSF7KjoxR/nqTpAA9/uRpMxsVkAD+NnwwmkydPjo4mkzRNUzZf5Brhbq279gKoQ7NGUIliOhOEUIUsbn0dkq1zZrqLlvFRuuVfIieHh/fj/y1oVcS6feycdf88+AskUHov+vcFtM33c+PblaoLxe3lw+lxaiNBjuXKL79W2l+g97DEu1x7WDQYY1eJvxr2fK4I3cr1Av3OvNG6Dx/jWTTfl8A6kd/m81f3FEbfVkil5RhbhoIaml8mR1Cr0Wo8Cr3RjzZdj9yOunY64nQKFXhhgzn2mmA7Dkxfze5l5oWZCsKqtg70wGMFhlTe5aVfe8IqpOt0JiK6oBJIeLIOfSIcklO44kceFxyCt8YLu0InOm7DC3NhfvhBPEegxqHn1wNxcPArUF523M7JOljiwUEWHlFUjSZVa9ypEbhYqFyhIb2Oswo0ZCtgvpyqAj+Rg5zPFfWfd6c5DxMLq36uAkmNKzB0p7nxPL0YpgdaaDDLBpYouJMp5svadh1dPO/mnUA26BaQO+u9CGUisGGDBNtHRq19bK0MvwmPPP0Q6nXUPi+VuRbHbQVkxSdoeHhC0Va9BrQA42/ReXEFHgsuIRFCFaG6rQNEd6io98RBXYq3yjeg1Z8h3lj5zBAGW62w8/UySK76klHFM5s3FcPMHeTX7bHDc8QDw7ZqtRStcDtNNrVHR8LHUbGNg6nLS0WYczDw0rzELtIajz67MAO2SBuU4lSZa8+YT60xmPfcFiIRHIpcW49CGUGqwrh95/x727sgB63XwqtKaXA9q/Hm42jObyDzOVVbxz1UKLoe0zKoHULBgTVlQ+/ZXmsVPEcOQguLLbG1YZtToC+MaH9tNYc8VPN27OoyJ5guDgs5cve9E5nWkJcoDofcjxqnZSZLotpno9Ht7e0QwuehdctRu9ePTmdPj1+eHw8Oh+mwpCpMIcwxlovxMB2mvFRbTxWYHta9C8XntWZz15H+l9tHW35526jWoEJnCUbYtIX1vYRayUSuxjKJFw8mnfWuIL3rSqiwl4ksrSfeutlwGr5xervl5Tj2chcslIcr3Rt8r3H92dVjBbphbqFHPiB/851y3XT2PbK7Sf1O+JJfnGLpL7N/0IePXrfN87F4yNpdjzTrPmbHZmfnMBaUCAW6wCF+nuY51n2y96YYJr/rmCfHc7nd/gXQ2CLs
api: eJzVVsFu4zYQ/RWCpwSQLdm101Y3d9dIDWSTNPa2wAZBQEtjmxuKVMhRHMPQvxdDSba8jtNt0R6aSxLyad5w5r0htzwFl1iZozSax/xKOmQZZMZuWKElOraWuGK5WEotCMOETpnxcKHYolCqg/CKzIGwyarLpkWeG4uOLaRCsFIv2XzDcJNDl92BKxQ6JiwwZyxCSnuZccgsJKCRLaR1yM4y0EQA6aNA9nE8/RAwXIFmiQWB+9XzLg+4ycH6zCYpj7mSDh99/hIcD3gurMgAwToe32+5FhnwmM+FfnqUKQ+4pEPnAlc84BaeC2kh5THaAgLukhVkgsdbTunzmDuk8/CAo0RFC78I/cQmKS/LYBfbY+vAzwXYzUHkhVDuILTQm5uFz+2QhCLWK7pQipcPe9oZrbc5n/9jwt8O2JTMJP4Nxjqq1AhLsDzgKSxEoZDHvSjak1z5sG0is1g4+HeYWjw3VdSSDmjB5UY7cPR1P4ro16EhpkWSgHOLQpF8PZgHPDEaQaOvZ54rmXgFhl8dfbNtZZRb0ifKikEiZId/iDSVlZduW8hKf/VpzPwrJMjL3YKwVmxaKpz4YLRvUKg367BTjkeUQd3D96B1O4KmC+9hdyX9Nul2t+7rUzd5Bjsh1QwPbXKHn/wU+kxDqFX5w+40GywzKSi2MJapowkGOs2N1EjTAl5FlhPFrgf326qbr8hj/oexTywx+gWs8y0lRoGUUj/qDzpRr9MbznpR/EMUR9EXCqhRVk3jIyUTYGe347vpzfV5wC6NWSpgZzd3l6PryZfRbHJzfU5qpkE1HEbw0yCKOtD/ed4Z9NJBR/zYu+gMBhcXw+FgEEVRRKWq8qpCr419ckxgE9loGotsNGEIIuO74q+NVak3cN1m77Omj9FOKL1hVNJPwAf9/rH0fxdKptXQH1tr7D/XfQoopDoQ/iFAmeTQFn89pBoVlg+nnXFlqgRJxplbvjfKP4FzYgl7m52G+mKwZgi/q3g6V0Vd41oa35e3qu7pY3ysyvcWWQP5dTa7PQpY9TYDXBmS3NLPUn/ZxTx86YX1dAzpOnThtr4Vy7C5P0Pykh+/C+ML0pBJnTq5XCEjWja6nRwZs9nwltzhawWJxCuonvKVz9l04xCyajYlQGbfQ0a5SFbA+l2yRGEVj/kKMXdxGK7X667w211jl2H9rQuvJh/G19Nxp9+NuivM/NAjV1fp9bpRN6Kl3DjMhG5xHb2Avj3bdu+C/+FzqRYQJRHmSkjvDV/SbS2Ne/7Sa12dgX8tURXi/bOp9cLyGnkI+Mo4pI+327lw8NmqsqTl6tYmJ6fSiblq3dtPsNm/l16EKigxb/ET0OfvxDX3yvdgd2+MPfiB/rGS0G8nflIOZ3e198/ZqVI3FtebNmeTTVNhP9RWIFKwPoVqd5QkkLdzPZrBlPvO75fjGS/LPwFA9/71
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/memories/list"}
path={"/v1/default/banks/{bank_id}/memories/list"}
context={"endpoint"}
>
@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
List memory units with pagination and optional full-text search. Supports filtering by fact_type.
List memory units with pagination and optional full-text search. Supports filtering by type. Results are sorted by most recent first (mentioned_at DESC, then created_at DESC).
<Heading
id={"request"}
@ -47,7 +47,7 @@ List memory units with pagination and optional full-text search. Supports filter
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}},{"name":"fact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fact Type"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}]}
>
</ParamsDetails>
@ -62,7 +62,7 @@ List memory units with pagination and optional full-text search. Supports filter
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["items","total","limit","offset"],"title":"ListMemoryUnitsResponse","description":"Response model for list memory units endpoint.","example":{"items":[{"context":"Work conversation","date":"2024-01-15T10:30:00Z","entities":"Alice (PERSON), Google (ORGANIZATION)","fact_type":"world","id":"550e8400-e29b-41d4-a716-446655440000","text":"Alice works at Google on the AI team"}],"limit":100,"offset":0,"total":150}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["items","total","limit","offset"],"title":"ListMemoryUnitsResponse","description":"Response model for list memory units endpoint.","example":{"items":[{"context":"Work conversation","date":"2024-01-15T10:30:00Z","entities":"Alice (PERSON), Google (ORGANIZATION)","id":"550e8400-e29b-41d4-a716-446655440000","text":"Alice works at Google on the AI team","type":"world"}],"limit":100,"offset":0,"total":150}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

8
hindsight-docs/docs/api-reference/endpoints/list-operations.api.mdx
View file

@ -5,9 +5,9 @@ description: "Get a list of all async operations (pending and failed) for a spec
sidebar_label: "List async operations"
hide_title: true
hide_table_of_contents: true
api: eJzFVktz2zgM/isY9tJmFDvJ7Ek3b5tkM5NuO423lyTTQShYYkORLAk5dT367zug5Fez6c6e1hdTJPAB+IgH14qxTqq8Ve+p9XEFHwJFZONdUveFqijpaIJ8q1JdEgOCNYnBLwCtBUwrp8FvdeB1IFcZVwO6ChZoLFVvYOEjIKRA2iyMBqzJcQHGadtlWYrRR2gpJawpZfFBdQ9ZFWr7cVWpUokbXw7OA0ZsiSlKPGvlsCVVqmzti6lUoYwEEZAbVahI3zoTqVIlx44KlXRDLapyrXgVRC9xNK5WhWLDVjZmAgRXler7e9FPwbtESVTOTk7k75Ctm05rSmnRWfg0CqtCae+YHIs4hmCNzu5PvybRWe/c6Pu+L9RvZ2fPgT+jNVVWg3Nh7j+gqhCFMjaD3xUxGisrw9Sm5wLW64NTdKsPi8zuIUt9sd0xjqmmqPr7vtjsYYy42qPy2g8Oqr5Qbap/xfr7ISvUFuxl0UwGzOW039n2D19J88GN3+a4BtOj3P0OZkfvwO7LYbwb6PsnYxuRP+bzj88Ah7ttiRsvmVwT5+zlRpVqisFMl6fTnLZput6kbz89yHXjFj5zcZCcYw3PPl6pn2v3zs2AqQ0+oj1O1KJjo6EdFNIqMbW58GZXQ30m4AYZEvtIqYBIHA0tZSmVHQmTlLtfUhxADKXJnbtzr17BBSF3kZJ8HsHR0e/Iutn4dsM+Yk1HR2VeErSdZRMsbWGAFgujDTm2K3gy3AB27FsUfxeoGeg7R9QS14B/s4nmhjDqRqAvTHbS0hId75C7JO3GiXtowaKrO6wJvnUkxwPahZiQJIILY5kkx7KzGRtQR58SPPloq+yNEJK5Hzwa+fHBuNwPE0lXYrKrAX3eGPcI564K3jgW4Etycq8EuYa/c4cW0KUnigkeMEkTdKMJU5Fjw6tsYhPUgHsZMTTw2aQOrfmR00TArxxT5mpJm7uus+RyX3KAeOd114qZeUT9OIad14M9dMLViFKNwmm4oS4kigypC8FHHvNgFnVjmLQkg2zNG9pkWpcolXfuWBgZkxKujXtMYvOtd4703rXlTMRIoK1PBMYBm5YG9e3lP1PfJDlau4JkWmMx7rEmyucDnf9iWeKUZsviP7YE+Ra2IDchEuY5NhOiD7i31uSb44hLigltrrGRw7Gm0N45GH9jK0edW/k4wTaVk6mTdmSNJpkmO5FZQN0QnE1OVKG6aFWpGuaQyun06elpgvl44mM9HXXT9Prq7fmfN+fHZ5OTScOtFWDxcWgXp5OTyYlsBZ+4Rbdn61rm/8+D/+d+s96NpP/72TC2ZqmtabBo8tTJHK3HpnurMBhVqOWpKob3guiVey8Hf/Aqanxi0VqvpUD/irbvZVvayEqVt/eFWmI0+CCd+XatKpNkXalygTbRL5h6/WmcUW/gJcc3o8jJIFqi7eRLFeqRVvuPnTx9G8KKYvZhOJ5pTYH3FJ89FuRpsx1Ml+dz1fd/A2bNiYA=
api: eJzFVE1v2zAM/SsCTyugxWmwk2/dFnQB2q1ou12CoGBk2lYry6okpzMM//dBsvPVrAV22sky+fihp0d2kJETVhovaw0pXJJnyJR0ntU5Q6UYulYLVhuyGDCOfTCkM6kLhjpjOUpF2RnLa8uQOUNC5lIwLEh7zqQWqolYsra2rCLnsCAX4UPoQWbgsPtZZJBCaOPhyG/QYkWerIN02YHGiiCFNeqnB5kBBxnuYNCXwMHScyMtZZB62xAHJ0qqENIOfGtCmPNW6gI4eOlVMHxG/cQWGfT9KoQ7U2tHLkTMptPwOebqrhGCnMsbxW5HMHAQtfakfYCjMUqK2Hzy6EJMt++i7/uew6fZ7DTxL1Qyi2FsHnj7h6xgbCDMy6HvjDxKFU7SU+VOAaoWR17U7Y88cntMUs93Fqk9FWShX/V8a0NrsT1g8qoeGoSeQ+WK90i/HjQBu2RvQyMZ7D54+33tev1Iwh89+DLeayg94lb7NHt6B3bfvsbXgb6/FdtCvt3f35wkHN62Il/WQccF+ahdX0IKyeY8ySjHRvkkCNcl3ajfPjnSutR5HdnYVpI6c7IoPQs12cXNAvgr4Wwdcb52+FE+KKJ8xpm5pqq2LbtrnacqUKCkoKDgPeTCoCiJzSZT4NBYBSmU3huXJsnLy8sEo3tS2yIZY11ytfgy/343/zibTCelr1RIvCHrhvbOJ9PJNJhM7XyF+qDWVdg4r1fN6/t1+zH434tqlIOn3z4xCmVUeuSoGx96CZvzeIH41MDjlgqh6X5dHaRccShr50Nc163R0U+r+j6YnxuyLaTLFYcNWonroIZlB5l04ZxBmqNy9A5XH27HyThjb7W+HQAd5L9B1YQ/4PBE7cGCjSNfEmZkYwuD90IIMv4g7mRDhX26m4bL+T30/R+xTzbt
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
@ -28,7 +28,7 @@ import Heading from "@theme/Heading";
<MethodEndpoint
method={"get"}
path={"/api/v1/memory banks/{agent_id}/operations"}
path={"/v1/default/banks/{bank_id}/operations"}
context={"endpoint"}
>
@ -47,7 +47,7 @@ Get a list of all async operations (pending and failed) for a specific agent, in
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>

63
hindsight-docs/docs/api-reference/endpoints/metrics-endpoint-metrics-get.api.mdx Normal file
View file

@ -0,0 +1,63 @@
---
id: metrics-endpoint-metrics-get
title: "Prometheus metrics endpoint"
description: "Exports metrics in Prometheus format for scraping"
sidebar_label: "Prometheus metrics endpoint"
hide_title: true
hide_table_of_contents: true
api: eJydUsFu2zAM/RWDZ8/2ctStGII1wFoES3YygkKVGVurLWkindQw/O8DXXvNutt0EUDy8T3ycQTWNYEq4cE7yz5aV8MphQrJRBvYegcKtq/BR6akQ47WUGJdso++Q26wp+TsY6dZvoRM1EFapOADRi34XQUKFuQTuip46/hpDdTIkEJECt4REqgRNkUh398SDr0xSHTu2+T7UgwpGO8YHUu5DqG1ZmbMf5JgRiDTYKdBjZO8VFQ0XuS8sQbNDSjIFy2QgnVnL0C23CIouLeuIls3nNwfj/vkbr+Dj7tZE/P8f+oXbdrM2pzupNsDdj4OyWEgxg6mFFprUAZ5L7kL2jSYbLICUuhjCwoa5kAqz6/Xa6bndOZjnS9Yyr/tvmwfD9tPm6zIGu5aaXzBSG/yPmdFVkgoeOJOuxuuGwtXY1d7Pk45vm/6v46BhyCMjK+ch1ZbJ4rm8cbFhXI9Ebm+xhNLaByfNeGP2E6ThH/1GAdQ5SmFi45WP4tH5WlKoUFdYQRVjvCCg+zRGAwyxkW3vVD/cx7T6eYevm6PME2/AWkyDcA=
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Prometheus metrics endpoint"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/metrics"}
context={"endpoint"}
>
</MethodEndpoint>
Exports metrics in Prometheus format for scraping
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
>
</StatusCodes>

78
hindsight-docs/docs/api-reference/endpoints/recall-memories.api.mdx Normal file
View file

@ -0,0 +1,78 @@
---
id: recall-memories
title: "Recall memory"
description: "Recall memory using semantic similarity and spreading activation."
sidebar_label: "Recall memory"
hide_title: true
hide_table_of_contents: true
api: eJztWutv2zgS/1cG/JIUkJ95tBVQHNI0uxds0/QS7y5w2cCgpbHFjURqSSqJEfh/PwxJ2fIzaVocDofNhyalhsN5/maG0hNL0SRalFYoyWJ2hQnPcyiwUHoKlRFyAgYLLq1IwIhC5FwLOwUuUzClRp4SBU+suOfEov2H/EMCAAwyBDstEUqueYEWNQgDyp3Dc7e/qIyFEYKSCGoc+30t2HtQOk/3YvgZJWqew51UDzmmEwQ+UpWFElWZYwRlzhM0EeA9Smsix9NmQk4M2IxbyHhZopyzxccStUCZ4F4MF6SgQBNYLp5FkCh5j9o4dYhr4v4Ay+9QhkO4uTNQoh4rXWA6P0GVQgol92Kn/YjLuz0DngZGmAscm4i2mRLJYBhkvhf4UCohramNd40WhEzyKsUhSiusQPPB6grBKpigBbc4BTUyqL3hDfBcyYkRKYL2TtRoqtyaNouYKlE7svOUxcw/HxbBBixicycZFt88MckLZDEjDYYiZRETFBsltxmLmMa/KqExZTFJFDGTZFhwFj8x8jeLmbFayAmLmBU2p4WPXN7Becpms1u/HY39qNIp7VnllihpUVp6xMsyF4kTu/OnofB8ahxWalKKLEP/+6tCPd0lw78cwSxyBG4Ll9PLsVNXWCzM+uZAzGLGtea0eU4hqzxnpE3NfuC4RivZ9FkYC2oMY55Ylw2GHBjcs5/imJODaI0WxBikskDRIcYC0zckwahKJ+jMEchZzArnk1VNUVYFi29Yrh5YFGgyMclYQ8yPntuqnH4ZcrzH3EVskLGjcZxjYmEeP6ZNQhX8cWjVHcqm1YS0OEHdsPkFf4SBJ4sW4h923x+TaTVPsLF9pFSOXDa2DxxFY+eY5wZnkXf20IoCjeVFuezMVR9u95kLCRjM2axa5fz60mUvt5Byi+BZwj62J+0I9vrd/kGre9Q66A76B/FhN+5295zLxiL3mbQxxpbj9g53Ru0vOF0T6wItT7nlcIdTCh1/HChJZ9/zvMLXGuQ3t3n1PLdKBxXcJlkbzsfwhSD7QdjMrw0radB+GFAC+xUCVjmlKFI6hYcMNTpxhfEhjjbE0Xz3zki4IDr41dGteWkM/mCemyBjONeEg20mDBRNqy3EaIYXAdBskfRq9Ccmdgnwbpy/GharffGT88GabH7ZJdT8/LHAPDVtuAh2WpZ1/w6nH5wT38DllftvLeobIpFrFid4x0delDnOA4oZVWmXO0sW9ggbQoSZnCd3bPYtKPdTiOwteo6mczXbcFHlVpQ5hvg0wDXCyZdPmIJVE7QZahcDoc55hGsyvSx9XSPreSLXaqSpCD2EM+d+XR8d/8AsJVGCX99QeVvKuXrHcpos07wO4ZbSlD+KoirAc3FabKjazfg76nY3hV991pnbfe41DMZZO3Wz0Ta1C0Ku9QmbXL+SbP70TQzbrmuxCmgr/U6F4aN8TuukMdQiNnVetnSwQJJV8u6/7x5/LOyH3wWfUndqdSUTbqkcN+R+13vf3+WsU+LxKl+F07/LPZo/BD5zrzzN6F+U5JJozUd1LxLXK+mbNtul34pqz8Gmb88aSOLnjCvfC65ZJqxDoVLMG/0IoExdp7wCenWTFLqeeQG+eQUe3i5BUhMrNkRqc4n6mqhuRNnvNIGkIoWTXCQIhk/DqFHwJBMSIUeupZCTf7ANDQ3b0Fywec/k5Q6N7A1z85IzSD3EsNsZ/ZAPTKmk8fL3u911lL2ukgSNGVc5XAVi9uouPIQq/bml3xHprnaHZoSIWXy0u6gG9HwecK9rdahfJx6ba8EPGAjOasazYE2v02tkPQ3bZxFTSVJpjenQWK5fzfAycIFrx6XJF2X63VzPpHNjQbZVEtMhf7WkFzUPOHFypiqpiO9QvFrMT4EFnAcpfcOyzG7RZXxdCt9t8RBAb7cq4aC6wH2HDq66+Il6N+76QZGCZwP2Uq6uQe+1kJN85QoBKB9WIHehAjs8Osa37953W9jrj1oHh+lRix+/fdd63+31Dw6PjukZa2QBAdYdCDlWbMWjzKChFmHIR0mvf8Ca+XnDHJKyiP2s1CRH0sjt6fUPkE5p4bv3o1avnx60+OHRceuwf3zcO+y9Pew67FwORwLYw1a31+odDXrd+IAA9t9sORxC0ZhXhtU02cZjNUm30QVr+AJBNjHALXjtQEmwGcLJOVjkxWLc92C/1rU3vesxuDliPxfYi4Lyslj2k/lW+NyWPRva8Olwd0XwTW/I1YRLJUXC86G/oNq+7bSmhC9ESa5rNt3b69NLa8+PB7dnMnk1ib1hLhdaNar3ckafyGafHroQLkNf3l6rag1Eb9rsOQEX7lxz1Ir117S4ttziVvlPKZmkBTI5z0NPqMabVXhB8M4r8+pBIdYMSdMY2Gi2nLvb9+XzDNs0qbws+n9kIxSwWKb4uHMcCmXD0Tl4CJPNM7dwNdWqvX7P3BTvcMqJACQwPHCzGJog9XdHrkmGXBTCmvUrvRdXsWVdVyviJwLutfBxkvmrF6WBg/EVzjH6xtA59e7eeISPGLrpNRFdMvlLiHmZfE7HOqg21enNeVE/2D4lmU0120Xfi0r2osr7yOqGgvvCev8N5a0N1xnuGRghunWNTp0DmCLXpt32s2iz2PhegCRcqQnzLqFRXl7SIvRWUYpS+WU9w7fU8dltGMv8nHTz4xqpH9cp/e90ObeNHkZWxXBut94rB20asYcGEyVTw+Juu9c/mIVR+bDfX5+Of+O5SH3dPNNa6dePxilaLvIdnUeukqWnL+goaoSf3W6v4Z+VF9A1LWayq5xcoDF8gs3RemtbRsYAP0Q/A2yklz860C2/cAjm9dbdrsYnb75dV1L/HAy+rjH0vi3QZopiuVTutsm9yYxZ577XCZWoQ+86TecpvPKcdeqXox2PqSxi5OGrxcvLs7+vn3ZcP5EWY+VCqHaPkKkRk8wCOQpOvp6vVbT6gQP/OX3IOZ64nAsof+E/ULieGosFxQ2pSVVyQXJS8iRD6LdJ9ErnLGaZtaWJO52Hh4c2d4/bSk86Ya/pfD4/Pftyfdbqt7vtzBa5e6OG2njxeu1uu0tLFEUFl42zlj6bWNXraYEZf39f8f/5fUXAJKp1nTLnwsGti7mnADY37L7XaHwj93EFtZLx4iuLxgcZAXVuI5YRZMU37OlpxA3+qvPZjJZDot/cEoJoQXf2DnDq+/vQWu8Ixf2rgNJvYJsGNRhLiukaqFgUUK0W3JWfDHmKuoF5p/6glisSi91rNZPqmd9xkiRY2p20tw0s/3p5PSA7hg9JqAumb1s4ff1A/zpJVTmf+N3aE8u5nFRU5mLmedLPfwAcs5NC
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Recall memory"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/default/banks/{bank_id}/memories/recall"}
context={"endpoint"}
>
</MethodEndpoint>
Recall memory using semantic similarity and spreading activation.
The type parameter is optional and must be one of:
- 'world': General knowledge about people, places, events, and things that happen
- 'experience': Memories about experience, conversations, actions taken, and tasks performed
- 'opinion': The bank's formed beliefs, perspectives, and viewpoints
Set include_entities=true to get entity observations alongside recall results.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query"},"types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Types","description":"List of fact types to recall (defaults to all if not specified)"},"budget":{"default":"mid","type":"string","enum":["low","mid","high"],"title":"Budget","description":"Budget levels for recall/reflect operations."},"max_tokens":{"type":"integer","title":"Max Tokens","default":4096},"trace":{"type":"boolean","title":"Trace","default":false},"query_timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Timestamp","description":"ISO format date string (e.g., '2023-05-30T23:40:00')"},"filters":{"anyOf":[{"items":{"properties":{"key":{"type":"string","title":"Key","description":"Metadata key to filter on"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"Value to match. If None with match_unset=True, matches any record where key is not set."},"match_unset":{"type":"boolean","title":"Match Unset","description":"If True, also match records where this metadata key is not set","default":true}},"type":"object","required":["key"],"title":"MetadataFilter","description":"Filter for metadata fields. Matches records where (key=value) OR (key not set) when match_unset=True.","example":{"key":"source","match_unset":true,"value":"slack"}},"type":"array"},{"type":"null"}],"title":"Filters","description":"Filter by metadata. Multiple filters are ANDed together."},"include":{"description":"Options for including additional data (entities are included by default)","properties":{"entities":{"anyOf":[{"properties":{"max_tokens":{"type":"integer","title":"Max Tokens","description":"Maximum tokens for entity observations","default":500}},"type":"object","title":"EntityIncludeOptions","description":"Options for including entity observations in recall results."},{"type":"null"}],"description":"Include entity observations. Set to null to disable entity inclusion.","default":{"max_tokens":500}},"chunks":{"anyOf":[{"properties":{"max_tokens":{"type":"integer","title":"Max Tokens","description":"Maximum tokens for chunks (chunks may be truncated)","default":8192}},"type":"object","title":"ChunkIncludeOptions","description":"Options for including chunks in recall results."},{"type":"null"}],"description":"Include raw chunks. Set to {} to enable, null to disable (default: disabled)."}},"type":"object","title":"IncludeOptions"}},"type":"object","required":["query"],"title":"RecallRequest","description":"Request model for recall endpoint.","example":{"budget":"mid","filters":[{"key":"source","match_unset":true,"value":"slack"}],"include":{"entities":{"max_tokens":500}},"max_tokens":4096,"query":"What did Alice say about machine learning?","query_timestamp":"2023-05-30T23:40:00","trace":true,"types":["world","experience"]}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"entities":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Entities"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"occurred_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred Start"},"occurred_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred End"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"chunk_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chunk Id"}},"type":"object","required":["id","text"],"title":"RecallResult","description":"Single recall result item.","example":{"chunk_id":"456e7890-e12b-34d5-a678-901234567890","context":"work info","document_id":"session_abc123","entities":["Alice","Google"],"id":"123e4567-e89b-12d3-a456-426614174000","mentioned_at":"2024-01-15T10:30:00Z","metadata":{"source":"slack"},"occurred_end":"2024-01-15T10:30:00Z","occurred_start":"2024-01-15T10:30:00Z","text":"Alice works at Google on the AI team","type":"world"}},"type":"array","title":"Results"},"trace":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Trace"},"entities":{"anyOf":[{"additionalProperties":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"canonical_name":{"type":"string","title":"Canonical Name"},"observations":{"items":{"properties":{"text":{"type":"string","title":"Text"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"}},"type":"object","required":["text"],"title":"EntityObservationResponse","description":"An observation about an entity."},"type":"array","title":"Observations"}},"type":"object","required":["entity_id","canonical_name","observations"],"title":"EntityStateResponse","description":"Current mental model of an entity."},"type":"object"},{"type":"null"}],"title":"Entities","description":"Entity states for entities mentioned in results"},"chunks":{"anyOf":[{"additionalProperties":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"chunk_index":{"type":"integer","title":"Chunk Index"},"truncated":{"type":"boolean","title":"Truncated","description":"Whether the chunk text was truncated due to token limits","default":false}},"type":"object","required":["id","text","chunk_index"],"title":"ChunkData","description":"Chunk data for a single chunk."},"type":"object"},{"type":"null"}],"title":"Chunks","description":"Chunks for facts, keyed by chunk_id"}},"type":"object","required":["results"],"title":"RecallResponse","description":"Response model for recall endpoints.","example":{"chunks":{"456e7890-e12b-34d5-a678-901234567890":{"chunk_index":0,"id":"456e7890-e12b-34d5-a678-901234567890","text":"Alice works at Google on the AI team. She's been there for 3 years..."}},"entities":{"Alice":{"canonical_name":"Alice","entity_id":"123e4567-e89b-12d3-a456-426614174001","observations":[{"mentioned_at":"2024-01-15T10:30:00Z","text":"Alice works at Google on the AI team"}]}},"results":[{"chunk_id":"456e7890-e12b-34d5-a678-901234567890","context":"work info","entities":["Alice","Google"],"id":"123e4567-e89b-12d3-a456-426614174000","occurred_end":"2024-01-15T10:30:00Z","occurred_start":"2024-01-15T10:30:00Z","text":"Alice works at Google on the AI team","type":"world"}],"trace":{"num_results":1,"query":"What did Alice say about machine learning?","time_seconds":0.123}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

79
hindsight-docs/docs/api-reference/endpoints/reflect.api.mdx Normal file
View file

@ -0,0 +1,79 @@
---
id: reflect
title: "Reflect and generate answer"
description: "Reflect and formulate an answer using bank identity, world facts, and opinions."
sidebar_label: "Reflect and generate answer"
hide_title: true
hide_table_of_contents: true
api: eJztWG1vGzcS/isDfjkbWK9eYrt3CxSFk7o44eI4Zzs94FQjoJYjLWuK3JJcK4Kg/34YkiutpNgphH5pcf5g2FzO2zMzz5BcMYGutLL20mhWsDucKiw9cC1gauy8UdwjcA1cuwVaaJzUM5hw/QRSoPbSLzNYGKsETHnpXRYkTS21NNrlv+hfNADAQyUdoBa1kdoXcW2Qwx16K/EZHeCXGq1EXSKclEY/o3WcXHJBHz6j9u40yg27ch3TYFHhM9cevAFfIfzWoF1GmTe7tqTzFEbrJpxQQH9zUKN1NZZePmNr7TyHTw4dvH9/Q3o7mEBptMcvvuEqoRMlLnK4/uJtcImcd95YpD+XoHGxNUqqUESZy+BfY7WDWnGpgRQnrVkIJobYOBQR4q4qljFTow2AjQQrmI1ZZBmrueVz9GgdK8YrpvkcWcEo3M9SsIxJSnrNfcUyZvG3RloUrPC2wYy5ssI5Z8WK+WVNYs5bqWcsY156RQtvqQ5Ggq3Xj1EcnX9rxJJk9rUFtLSnT7yulSyDu71fHdXdqmOsthSMl+jov5DE13z4d9iwztikETMM+gVOeaM8K5gyC9q6J4q6mbNinL7OAxCVnFXssRNa1Jbt9UdcBoXPqEIKwWLJleolyGGTCJeTU6lGQtR6eTsNWdj1Z51tVnSjFFt3vHiXxNcZm0oV09jVJD3O3SFoT/gqZP/C5UFgN+i54J7DEy5DoQdzYDTZfuaqwWNj+DkI79sLq2Rozn1Z5TCawgejERbSV3Htc6Md+u8fqHriSuoii6WxAhYVWgzuSgfaeHDoA+Yd6Q4KE2MUct2B4Yb2waewb9+90RSiYa5c8jHZdcmwJ0qbd1HbuhHUpRqk6l+vN0VoJr/Gztz2xzjkq4NYm4ufQg4OfIvLofg29qcSlXA53CScdn09ecLl9yGJp3B7F/5tXT2lLfoA8Zza5Auf1wo3BcWcaWxJqdxBOLZ3KhHmFC+fWCdgbi1fvlogP6XKfiHOyXITZg43jfKyVpjq0wG3CFcffkQB3szQV2hDDUhdqkZgZIOu0tvat+wLcRNNAi6EpHWuIMB5IqTjE4WCrKdUnhKd7rRZ4OTdttjZ8JWsb2Im0VF0Mrl0EP/XXY2D4GTCHYrPRp+C1NCSj0XXKB+Y5xDuvQKPtpM6X3Efxkwa89JBMABG53CPYaSu1vQbNeGSAaml/xNQcJJQKtoVcZqzr9V9i0A6aexh8K1OiePg8UDNXRw+BximdZgbgSrxdcSqPY3sVXo7RdJw2PA3C0cYGbPBCWnktqyg5nWgSbgaAfpKlpTHDVePj2idx53qbWuMgEmzkP2HsiUMLE1DNKSfgE9M44FbL6eylFyB1B6VkjM6Uf3A1vRDQLraaBeLd9jvH3bHfVOW6Ny0UXCXNrOjR3c7+F4aQw9psrWlTHtfGGhSHDt96HSS/W5X4vfjLD3Q+h868k1ZNtai+Ow8t0crvE1a4D5o6epFfTSuG63XWnyza0NAh01LJHjQsVeBksJJl6gt1ndbuXvNuu3OCrnyVUnTQEhXNs6RtiwUDhsM3+D5xeV3Z/j3f0zOBkPx5oyfX1yenQ8vLwfng+/O+/0+24eFDfvD87P+4Gxw8TDoF2/6Rb//X3aYlJf2JceuRkQabTRbN7fH0nCFOZyY3VM2Sd/q7qli/Hgk5p223mfK+KFDlRH7l4hy07Xj1QbmI+LOkvT5xeVWetRmEQURa4d1HCjuPCwQn7aqtrfHWKNRyds0wWC+hEYLtM5zTTM0g+gdB2+5dnQR43TnA49lpY0ys2We5y1rng+Hh0T5M1dSBIfg2lpjj2dJgZ5L9Qr3KVPufP0d3UrsP0PL1o8vV9V7Ex0MJ2Y3e40db9A5PsMuQb60NYABkQq/UaAUVzSd9u3eGRK8Ed2Xw/gxwvfaSeOfDw8fDxTG3M7RV4aqrzYuXpd9xQrWex70Uqv16K7seqt0ZV73tndryuzd9tJ7/Vc/RJDKqQnZb5GVWjg5qzwQxnD1cXRAK+2HEPJmfwKF+L/YvErc4NzYJdwvncc5mVOyRKKq7ZarmpcVwjAnvm6sIub3vnZFr7dYLHIePufGznpJ1vXej95df7i/Phvm/bzycxXus2hddG+Q9/M+LVEBzLnu2Oo+hc1Q07W+PR/vR7naNv//X9D+pC9oiT1IrBc0UFWEElslWhiz50FnBmfhGY1Ei+17WssOjxmriFKKMVutaFR+smq9puXUf+NH6lkr6aoUWry9NrFiypXDVyrs5C6x6Cm85HdLlpqosqUGliUead0N46FCLtB2WOZdNHQWSHwrfTDTaN5EiauyxNq/uvexw7Ufb+8fCL30UEjnDXqz5ESV9Dt4atKFkF4SaW3FFNezhsZQwaJO+vkfSajKzA==
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Reflect and generate answer"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/default/banks/{bank_id}/reflect"}
context={"endpoint"}
>
</MethodEndpoint>
Reflect and formulate an answer using bank identity, world facts, and opinions.
This endpoint:
1. Retrieves experience (conversations and events)
2. Retrieves world facts relevant to the query
3. Retrieves existing opinions (bank's perspectives)
4. Uses LLM to formulate a contextual answer
5. Extracts and stores any new opinions formed
6. Returns plain text answer, the facts used, and new opinions
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query"},"budget":{"default":"low","type":"string","enum":["low","mid","high"],"title":"Budget","description":"Budget levels for recall/reflect operations."},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"filters":{"anyOf":[{"items":{"properties":{"key":{"type":"string","title":"Key","description":"Metadata key to filter on"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"Value to match. If None with match_unset=True, matches any record where key is not set."},"match_unset":{"type":"boolean","title":"Match Unset","description":"If True, also match records where this metadata key is not set","default":true}},"type":"object","required":["key"],"title":"MetadataFilter","description":"Filter for metadata fields. Matches records where (key=value) OR (key not set) when match_unset=True.","example":{"key":"source","match_unset":true,"value":"slack"}},"type":"array"},{"type":"null"}],"title":"Filters","description":"Filter by metadata. Multiple filters are ANDed together."},"include":{"description":"Options for including additional data (disabled by default)","properties":{"facts":{"anyOf":[{"properties":{},"type":"object","title":"FactsIncludeOptions","description":"Options for including facts (based_on) in reflect results."},{"type":"null"}],"description":"Include facts that the answer is based on. Set to {} to enable, null to disable (default: disabled)."}},"type":"object","title":"ReflectIncludeOptions"}},"type":"object","required":["query"],"title":"ReflectRequest","description":"Request model for reflect endpoint.","example":{"budget":"low","context":"This is for a research paper on AI ethics","filters":[{"key":"source","match_unset":true,"value":"slack"}],"include":{"facts":{}},"query":"What do you think about artificial intelligence?"}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"text":{"type":"string","title":"Text"},"based_on":{"items":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"text":{"type":"string","title":"Text"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"occurred_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred Start"},"occurred_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred End"}},"type":"object","required":["text"],"title":"ReflectFact","description":"A fact used in think response.","example":{"context":"healthcare discussion","id":"123e4567-e89b-12d3-a456-426614174000","occurred_end":"2024-01-15T10:30:00Z","occurred_start":"2024-01-15T10:30:00Z","text":"AI is used in healthcare","type":"world"}},"type":"array","title":"Based On","default":[]}},"type":"object","required":["text"],"title":"ReflectResponse","description":"Response model for think endpoint.","example":{"based_on":[{"id":"123","text":"AI is used in healthcare","type":"world"},{"id":"456","text":"I discussed AI applications last week","type":"experience"}],"text":"Based on my understanding, AI is a transformative technology..."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/regenerate-entity-observations.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: regenerate-entity-observations
title: "Regenerate entity observations"
description: "Regenerate observations for an entity based on all facts mentioning it."
sidebar_label: "Regenerate entity observations"
hide_title: true
hide_table_of_contents: true
api: eJy9Vl1z4jYU/Sua+9TOGGwTkm39lqZpm85mk0loH8owjLAvoI0seSVBlvH4v3eubMcGCtvZ7pQXQLo69+ucK5WQoU2NKJzQChJ4whUqNNwh0wuLZstpw7KlNowrhsoJt2MLbjFjWjEuJVvy1FmW05ZWQq2YcEMIQBcEI7S6yyAB84Y7rzHmfXgIoOCG5+jQWEimJSieIySw4OplLjIIQFB0BXdrCMDgp40wmEHizAYDsOkacw5JCW5X0DHrjFArCMAJJ2nhJ65e2F0GVRW8YTdxfAP027oqHn9GALbQyqKlM6Mooq/9Kj9v0hStXW4ke2qMIYBUK4fKkTkvCilSX5zwo6UzZS+OwlBxnag9iOxcbBRUAClXWomUy3md/Gn7m9aSfSDLKoCms/NUb+rgmqNCOVyh6Z29ry3ZjbesAlgKY93cIvoEuNo9LH13951TT5oVtZESqIYt5C+EwJ4JoQpA8v8I95730HJ0POOO74PxLBOUBZePvTLXVGhg9eIjpu6so/sWuwpgj+nUMIe5Pe6jw8/uXGcmtN/1A7M5d19bh/sWg107EsVBZn0RTOvAZod0f+iy6nF4n+fXqj9FGF/ojevGyBA6x9wYvusl+9Cv2ZcC9BI+oPghbw/acJTOz+i4kCczaTdYrjOUfhw2szDzBxmqrNBC+dGHn3leSC+zQ+HB73qtYF8ZMIpG40EUD+LLSRwlF1ESRX/RUKLBGY8ucHx59W6AP/y4GMSj7GLAx5dXg/Ho6ioex+/GURTBnjIauNEgiifxOIlauAMdx5eHzJyWB9w6FVjNVJ8Ke9XmxTLu2K9aryRCNavoE8B4NDoefH9yKbKaDLfGaPP1U68u+xk5SZ3u7f4LmbQTrZqdJuZ7XQfolWhX5wR7j9byFXYsP3ODUDHYhHa/RHbKq3bd2PWo3JW3ru7pNGq6/6Oz1uS3yeTxCLDubY5urYmdhbbOX95uDQmE2zjMcMk30oV0c9uwbC7wKvRqEWjD8u3ercLuVeDv4KX2NWr9C5VZsVo7RpGw68e7I1W2G16Pb/YNqXjqSdXo7h5zbXbseWcd5v4uESmS0juT64Kna2SjIQlqYyQksHausEkYvr6+DrnfHmqzCpuzNnx/d3P74fl2MBpGw7XLJQFv0dg6vHgYDSNaojLlXPV89d5ZzRw5eA/tJVp2KvmGL7Sm8aTmsJBceE77vMumo1PYxj4W31MI/HuMoku6h1nbWFrtP6l6vZ0FsCaiJFMoS4rsDyOripY/bdDsIJnOAthyI/iCOj8tIROWfmeQLLm0eKYc3z012vienUqplYAiAWy53NA/COAFd70nJs2B/9FtVyo/bdbIMzQ+93r/Ok2xcL2TR8OR7vM3IT4+PE+gqv4GTRYCiw==
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Regenerate entity observations"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/default/banks/{bank_id}/entities/{entity_id}/regenerate"}
context={"endpoint"}
>
</MethodEndpoint>
Regenerate observations for an entity based on all facts mentioning it.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"canonical_name":{"type":"string","title":"Canonical Name"},"mention_count":{"type":"integer","title":"Mention Count"},"first_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Seen"},"last_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Seen"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"observations":{"items":{"properties":{"text":{"type":"string","title":"Text"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"}},"type":"object","required":["text"],"title":"EntityObservationResponse","description":"An observation about an entity."},"type":"array","title":"Observations"}},"type":"object","required":["id","canonical_name","mention_count","observations"],"title":"EntityDetailResponse","description":"Response model for entity detail endpoint.","example":{"canonical_name":"John","first_seen":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","last_seen":"2024-02-01T14:00:00Z","mention_count":15,"observations":[{"mentioned_at":"2024-01-15T10:30:00Z","text":"John works at Google"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

100
hindsight-docs/docs/api-reference/endpoints/retain-memories.api.mdx Normal file
View file

@ -0,0 +1,100 @@
---
id: retain-memories
title: "Retain memories"
description: "Retain memory items with automatic fact extraction."
sidebar_label: "Retain memories"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv27gS/isDvpwGUHxr+yJgH9I0uydAuw1S9xQ42cAYi2OLG4lUSSquYfi/L4aUZMlu0kX3ceuXxLzM9ZtvxtwJSS6zqvLKaJGKW/KoNJRUGrsF5al0sFE+B6y9KdGrDFaYeaCv3mLGl0Z/6D80AMA8Vw6UA58TlCyEtKyM0h5WxoLzxiq9jpIVuRFce3B1VRnrHSyNz8FtdZZbo03tALUE7C9U1mTknNLrqO1RYdAUDkGFFkvyZDtrfiX0tSWXxq/ncLVaqUyR9rBEn+UnAs/h4ikXYWVNCZoFYgEF6nWNa+oEa6/8FixlZq1VOM/WF0o/9IS/NVldsnYWyhvHYa0rR9bDi01OGmRzeqEkh7Sy5lFJkmB0zMlZK3ZOZWXYKlbpqETNso50fwjZ5UNPRbTNIIHbOk/lwS4sim0Tw+kIrmJM3EHVKnwNAeJ0ZEZ70j5emI3gN9Jk0ZMDKpckpdJrFzdfjuAtyboqVBb2nSpVgTYKjEdejeDSUtj1jZ9JpzkJLlMMPjvcXHo9gjmH2HVBhJI8SvTY+vmZQxxi8Yu3NXUQuSVfW+1AlSVJhZ6KLeDKk4UvNdWcM3bRo3tob9x0MYQcq4r4sg6nlpg9rK2ptWzPfnIUdkzFEVFGu0OFeAOl0coby2lZW3LuG8ausHAELyStsC78WWf3Z1Scg3i5tccbyExZFeTp2L/oExZFV42AlkKJkmz1/m48pXC9AuyzAeToAAf49Dl6wMISyi3QV+W8S6KjhTzkgJPFVjayas1fNqooYEkgic2UsKSVsQQZJ5190LQBo8nBi6Y6lpTjozL2jOmj4yZW5rCkgVnsESegIgnerMnnZEOMqCOCQ7RGIhFdXq6lSIUNRLhoAyQS0XGME+ndTmgsSaRiifphoaRIhGL+rNDnIhGWvtTKkhQpAywRLsupRJHuhN9WfM15ZkORCK98wQtvUD/AtRT7/X28Ts6/MXLLd46lNUXGW1jFAlJGj/90TOG7nrLKslOe7U93IjDH4J/hfk/sU1ZeNkf2vFSS81hWwQy9/bAKYTm+uTK2RC9SIdHTOV8S+6Q7puuiEOxxq2DeSd03fn71zyl4TtZlc32fiJYBhqJQShWZ8WYQiGMV7YJZ/kmZf1bn+1bRPhE9NP6oC13XuGaEDVt1x+pdjV2/DQD33Ih7NTsS+xMf+hC96zI/cITvc5GdKP6o9LqgASuw2lgxXEn0FZl4BpgSF4XK+JJmKSTB5fQfBxtjQzPkphnK/f07KI2kQvTSLzxhCSWRj5gaBFY06wttPLnFbDJ7tZhMF9PXYpj2LEetqRCpIL1WmqgBqDO1zUI6CswejpAtWNz5ZHo+fT2fTtKXk3Qy+X8/nGgtbnsFEliJhQTG7oFpaUxBqHtHL8KJ4+BeryAUeUtOg55dbLm9HFrLiPk5dIUENqjipNWwPs8hbatI46GzoC2siDSsfA8YkSl6sIjz4W3kpxPjm/WYwR4oukZ3hI4mSNGDlpbuTlHDKHGAHn4zZl3QABu8d4KJzOhHsi7w4mI6exmK7CD1jVnChismVwF9W3KerAyZ/I6g5+AxaeBxv+cPR9JVRrtIKrPJhP8clVKdcZJXdQG3zWHxw/zuorBnQdcoZIS2nevvNKUmOYvM1IMGobSnNdnjAoDLcO4flMHnPDbswcAEG+zGVpJHlfFdkmvDk/R7ds+r1thvoL3LzDHc48YP4r1LgKgd2QiuQZhnySGnTAoNrF7NZqdI+h8WSsYoXVlr7I/DSLILxTNzQmGywe7faGwtTvb3T1PnOxMNDP3arZ/D5XtyDtd0aM1PHw3BgDnvfg8g7FdU3ZzrIeEQ3hjdp914G8P3LWXtkf/O5zcnAmNuS/K5YUhUJvBrmCdTMX6cjhvmHjNs3HjXoGc/7o2onNrbw+x49S9gWp67VyYgoI2u0tKpde6B4wwXN9cnhdtuhJLtzjfOYhZKppnv4xwEH8PPYk47h4nJ4HDkosIsJ5iNJiIRteURI/e+cul4vNlsRhi2R8aux81dN353fXn1+8er89loMsp9WbBg9j6aNx1NRhNeYhCUqHu6+u8zMecDz/qh//mU8/Mp5+dTzs+nnH/hU07TeLlvjasCVZgpAjPvmo56Jx6nvV9DcRhjOk0Pw2FHsveJyLkdp3dit1uio0+22O95+UtNdivSu/tEPKJVuOQOdLcTUjn+X3Yd90mWfnHbTCBn8JTh7aChuWk+YlHzN5GIB9r2HqBCL8wJJdlgQtxtHmzOwwB0uH0yD3LXjjcusowq/+zZ+96ccvPh45zD1zxV8STMr2e44eEKN9FSExwPw2JY24mWeUUqokz+/AWKXYOP
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Retain memories"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/default/banks/{bank_id}/memories"}
context={"endpoint"}
>
</MethodEndpoint>
Retain memory items with automatic fact extraction.
This is the main endpoint for storing memories. It supports both synchronous and asynchronous processing
via the async parameter.
Features:
- Efficient batch processing
- Automatic fact extraction from natural language
- Entity recognition and linking
- Document tracking with automatic upsert (when document_id is provided on items)
- Temporal and semantic linking
- Optional asynchronous processing
The system automatically:
1. Extracts semantic facts from the content
2. Generates embeddings
3. Deduplicates similar facts
4. Creates temporal, semantic, and entity links
5. Tracks document metadata
When async=true:
- Returns immediately after queuing the task
- Processing happens in the background
- Use the operations endpoint to monitor progress
When async=false (default):
- Waits for processing to complete
- Returns after all memories are stored
Note: If a memory item has a document_id that already exists, the old document and its memory units will be deleted before creating new ones (upsert behavior). Items with the same document_id are grouped together for efficient processing.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"content":{"type":"string","title":"Content"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id","description":"Optional document ID for this memory item."}},"type":"object","required":["content"],"title":"MemoryItem","description":"Single memory item for retain.","example":{"content":"Alice mentioned she's working on a new ML model","context":"team meeting","document_id":"meeting_notes_2024_01_15","metadata":{"channel":"engineering","source":"slack"},"timestamp":"2024-01-15T10:30:00Z"}},"type":"array","title":"Items"},"async":{"type":"boolean","title":"Async","description":"If true, process asynchronously in background. If false, wait for completion (default: false)","default":false}},"type":"object","required":["items"],"title":"RetainRequest","description":"Request model for retain endpoint.","example":{"async":false,"items":[{"content":"Alice works at Google","context":"work","document_id":"conversation_123"},{"content":"Bob went hiking yesterday","document_id":"conversation_123","timestamp":"2024-01-15T10:00:00Z"}]}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"bank_id":{"type":"string","title":"Bank Id"},"items_count":{"type":"integer","title":"Items Count"},"async":{"type":"boolean","title":"Async","description":"Whether the operation was processed asynchronously"}},"type":"object","required":["success","bank_id","items_count","async"],"title":"RetainResponse","description":"Response model for retain endpoint.","example":{"async":false,"bank_id":"user123","items_count":2,"success":true}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

76
hindsight-docs/docs/api-reference/endpoints/search-memories.api.mdx
View file

@ -1,76 +0,0 @@
---
id: search-memories
title: "Search memory"
description: "Search memory using semantic similarity and spreading activation."
sidebar_label: "Search memory"
hide_title: true
hide_table_of_contents: true
api: eJztWN1vG7kR/1cI3kNaYyWtZMfX25dCSZzUQHLJ2eoVqGMYo92RlicuuUdyJauC/vdiSO56LcdK4T60BaoXSbszP873B3fcwdLy7IZ/wkqbLftcowEntLL8NuEF2tyImv7zjF8jmLxkVaBsrFBLZrEC5UTOrKiEBCPcloEqmK0NQkEUkDux9pDDr+qrYoyxWYlsAbm7c9saWQ0GKnRomLBM+8NAepCqsY7NkWmFTC+ywDxgrzbayOJVxj6gQgOSrZTeSCyWyGCuG8dq1LXEhNUScrQJwzUqZxOP6Uqhlpa5Ehwroa5RdbCwROVeZcybQqCNaBsidSWy6SXzJKwQReL10soyBytUERvsyrIazUKbCosOWNdCCa1eZV7zcIxlgYjNUQpc2IT4bI1kLYyyrgVuai2UszzhuvXMZcEzbr0v7qooKk94Z0Zy544rqJBn3B92JwqecEE+rMGVPOEGf2+EwYJnzjSYcJuXWAHPdpxcQvjOCLXkCXfCSXow9ZpfFny/vw38aN0bXWyJ6RAu18qhcvQK6lqK3As++s1SHO16p9WG1HKkQbbjvzdotseE+MUT7BPeRY8/Qm0/L7zSwmFlnwLsk/YBGAME0FGoRkpOGrVHvIfcsRm9JK5SqJVQy7t5UyzR9ZCFcrhE05NtFmnZm0BL2bOARjqejdN0n/AK7u+cXqGyR3E+wT2bBbIexFn60zkJZCDHHvtca4mg+mJ4ih7nAqTFfcK9w4RWdwW4A7MdWut56/wSQdg7Atk/GFbPf8PcPYqsm+jPHnuoIFchePhhfYnPWaULlJQeLEQ5Q1X4NBjyhOM9VLX0CvSC4Ib7msCTEPB0Zt/cZL2kDS/+N0roQhRsKkWOzMI2ZnoFeSkUMolglFDLP/MnZuOTdHI6SF8PTtPZ5DQ7S7M05d8IlHGadt6inNjTh6xja61sCPdJmtLXQZFt8hytXTSSXUVi/uKEMmgb6fzPLjUeU4jiWL5Ruifc4b07RjWj910ovCyw2ozziobjXgLzNrLvE+6L/r8V7BeEECM94YXOmyoW0xcCvosQoYwezx1fsr0u38gf8uqT9LkWaimxzZngekZuP0ibzsSUMysm1ELzA/W4RWsp6GGejyen/LE1KQfOBul4MH49G6fZKeXA36nBEOd4copnr89/HOCffpoPxpPidABnr88HZ5Pz8/HZ+MezNCRMkCBkIMlhGTj2QWtSQau23zqEineGCjm+PyznD/a5ivHer5QPjoKiEGG6+NLLgdCxHrviaKR64O+5r828bzmvTerD6hdePF/+7IEju+y+ec6p/01eu+35RDXVXSf9+IWV2YkK7yzmWhWWZ+lwPDndxzJ7Npk8ray/ghSFr5vswhhtXl5WC3Qg5JGqKnX+6O2/UCzaQWB/+3x4f9RBQIrvyi6P1eRPaC0ssV+WnyP1xogjz3eimvQKR0e6Xng/mDdY93k13gXzfeuwluQvs9mXJ4DBtxW6UlPM1trPEH6izfgIajFaj0e+/9vRrh1896N2Rh6FdOIJJ/9ePUywF/+jIwWN9AvtXftoSI+r3PTL5ZMi81VNmcOq1gbkoNvd4kZnt9Zh5StPu+rERck6bWgpMeiMwG4/MQiWViC9RsNaM/st74cf2HsE1xi09PeEnZy8AZeXrWzXThtY4slJ5n8iqxrpRC2xg2G4WIhcoHJyyzbClQwapysgeclLDO/JFqRXwL9utQl1lqDfCy+kxDUo94AcNldF4oFkEtSygSUy8qUgeQmtWwPYeyEdUsp4YUNFhtxoa5kPEC8NGcTbPm6FwT5x77PMIm1nDuU2oPtdgV3Euk7AYZV1yGIhb/wKbDdoLJuDxYLKazhCFKhcu2e3SgXcDwbqkv0qbANS/MPnDoFfKofeVmtsfb30lOs+ZYDoZhTqc6uotv8dzgNFtooo7dBgg4ea2qJxzDZ1rY2LcTA1eSkc5hQM9IhW4BhpjUWbfVUDskgMSvZRqJWlM99qpTDvuc1HIhhkudQWmVCMOkBg75z/hL0NcpBy215S9KxGzBfBnN85mfQUscdZqJB5L3Qg192Fx7S78GhtL6XwnnMG1mgshO4ebRhzCmS4LqBP7EyQ+84UN/k2c7zpqLpSpaFB4oFkWkNeIpsMqX40RvKMl87VNhuNNpvNEPzroTbLUeS1o4+Xby9+vr4YTIbpsHSVJGCSMZSL8TAdpvSIam0FqnfWo8ugwzqze+is/781+o/eGsUGSyVlVEsQfnbwobGLnfOGQy14wtfjttURX9a7OOpdMsUWepvwkrpvdsN3OypPfzVyv6fHsSHe3CZ8DUbAnPrSzY4XwtLvIt5HHImXP1zFgeOP7Dn527lCUeCtQTb0jyd8hdv+lZcfpUqEAo2XIbx+G04a+IHngf3J/EezWeCY5jnW7ijtbW8u+fL5esYTPo93YzTO84wb2NAwBZsgaojYsKTTsx1v+xDPeMCkzz8B+ztj2Q==
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Search memory"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/memory banks/{agent_id}/memories/search"}
context={"endpoint"}
>
</MethodEndpoint>
Search memory using semantic similarity and spreading activation.
The fact_type parameter is optional and must be one of:
- 'world': General knowledge about people, places, events, and things that happen
- 'agent': Memories about what the AI agent did, actions taken, and tasks performed
- 'opinion': The memory bank's formed beliefs, perspectives, and viewpoints
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query"},"fact_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fact Type"},"thinking_budget":{"type":"integer","title":"Thinking Budget","default":100},"max_tokens":{"type":"integer","title":"Max Tokens","default":4096},"trace":{"type":"boolean","title":"Trace","default":false},"question_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Question Date"}},"type":"object","required":["query"],"title":"SearchRequest","description":"Request model for search endpoint.","example":{"fact_type":["world","agent"],"max_tokens":4096,"query":"What did Alice say about machine learning?","question_date":"2023-05-30T23:40:00","thinking_budget":100,"trace":true}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"event_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Date"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"}},"type":"object","required":["id","text"],"title":"SearchResult","description":"Single search result item.","example":{"context":"work info","document_id":"session_abc123","event_date":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","text":"Alice works at Google on the AI team","type":"world"}},"type":"array","title":"Results"},"trace":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Trace"}},"type":"object","required":["results"],"title":"SearchResponse","description":"Response model for search endpoints.","example":{"results":[{"context":"work info","event_date":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","text":"Alice works at Google on the AI team","type":"world"}],"trace":{"num_results":1,"query":"What did Alice say about machine learning?","time_seconds":0.123}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

170
hindsight-docs/docs/api-reference/endpoints/sidebar.ts
View file

@ -4,13 +4,29 @@ const sidebar: SidebarsConfig = {
apisidebar: [
{
type: "doc",
id: "api-reference/endpoints/hindsight-api",
id: "api-reference/endpoints/hindsight-http-api",
},
{
type: "category",
label: "Visualization",
collapsed: false,
collapsible: false,
label: "Monitoring",
items: [
{
type: "doc",
id: "api-reference/endpoints/health-endpoint-health-get",
label: "Health check endpoint",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/metrics-endpoint-metrics-get",
label: "Prometheus metrics endpoint",
className: "api-method get",
},
],
},
{
type: "category",
label: "UNTAGGED",
items: [
{
type: "doc",
@ -18,14 +34,6 @@ const sidebar: SidebarsConfig = {
label: "Get memory graph data",
className: "api-method get",
},
],
},
{
type: "category",
label: "Memory Operations",
collapsed: false,
collapsible: false,
items: [
{
type: "doc",
id: "api-reference/endpoints/list-memories",
@ -34,56 +42,16 @@ const sidebar: SidebarsConfig = {
},
{
type: "doc",
id: "api-reference/endpoints/search-memories",
label: "Search memory",
id: "api-reference/endpoints/recall-memories",
label: "Recall memory",
className: "api-method post",
},
{
type: "doc",
id: "api-reference/endpoints/batch-put-memories",
label: "Store multiple memories",
id: "api-reference/endpoints/reflect",
label: "Reflect and generate answer",
className: "api-method post",
},
{
type: "doc",
id: "api-reference/endpoints/batch-put-async",
label: "Store multiple memories asynchronously",
className: "api-method post",
},
{
type: "doc",
id: "api-reference/endpoints/list-operations",
label: "List async operations",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/cancel-operation",
label: "Cancel a pending async operation",
className: "api-method delete",
},
],
},
{
type: "category",
label: "Reasoning",
collapsed: false,
collapsible: false,
items: [
{
type: "doc",
id: "api-reference/endpoints/think",
label: "Think and generate answer",
className: "api-method post",
},
],
},
{
type: "category",
label: "Memory Bank Management",
collapsed: false,
collapsible: false,
items: [
{
type: "doc",
id: "api-reference/endpoints/list-banks",
@ -92,48 +60,28 @@ const sidebar: SidebarsConfig = {
},
{
type: "doc",
id: "api-reference/endpoints/get-bank-stats",
id: "api-reference/endpoints/get-agent-stats",
label: "Get statistics for memory bank",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/clear-bank-memories",
label: "Clear memory bank memories",
className: "api-method delete",
},
{
type: "doc",
id: "api-reference/endpoints/get-bank-profile",
label: "Get memory bank profile",
id: "api-reference/endpoints/list-entities",
label: "List entities",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/update-bank-personality",
label: "Update memory bank personality",
className: "api-method put",
id: "api-reference/endpoints/get-entity",
label: "Get entity details",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/add-bank-background",
label: "Add/merge memory bank background",
id: "api-reference/endpoints/regenerate-entity-observations",
label: "Regenerate entity observations",
className: "api-method post",
},
{
type: "doc",
id: "api-reference/endpoints/create-or-update-bank",
label: "Create or update memory bank",
className: "api-method put",
},
],
},
{
type: "category",
label: "Documents",
collapsed: false,
collapsible: false,
items: [
{
type: "doc",
id: "api-reference/endpoints/list-documents",
@ -152,6 +100,60 @@ const sidebar: SidebarsConfig = {
label: "Delete a document",
className: "api-method delete",
},
{
type: "doc",
id: "api-reference/endpoints/get-chunk",
label: "Get chunk details",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/list-operations",
label: "List async operations",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/cancel-operation",
label: "Cancel a pending async operation",
className: "api-method delete",
},
{
type: "doc",
id: "api-reference/endpoints/get-bank-profile",
label: "Get memory bank profile",
className: "api-method get",
},
{
type: "doc",
id: "api-reference/endpoints/update-bank-disposition",
label: "Update memory bank disposition",
className: "api-method put",
},
{
type: "doc",
id: "api-reference/endpoints/add-bank-background",
label: "Add/merge memory bank background",
className: "api-method post",
},
{
type: "doc",
id: "api-reference/endpoints/create-or-update-bank",
label: "Create or update memory bank",
className: "api-method put",
},
{
type: "doc",
id: "api-reference/endpoints/retain-memories",
label: "Retain memories",
className: "api-method post",
},
{
type: "doc",
id: "api-reference/endpoints/clear-bank-memories",
label: "Clear memory bank memories",
className: "api-method delete",
},
],
},
],

79
hindsight-docs/docs/api-reference/endpoints/think.api.mdx
View file

@ -1,79 +0,0 @@
---
id: think
title: "Think and generate answer"
description: "Think and formulate an answer using memory bank identity, world facts, and opinions."
sidebar_label: "Think and generate answer"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v4zYS/isD9sO1gfy6SXqnL4V3N9sLkO3uJW4L1BssJtJEYkORKknZ8Rn+74chJVtOmuwi6Ic74PzFNsV55u3hzFAb4bFwIl2IS0JntNSFuE5ETi6zsvbSaJGKeSn1HaDO4dbYqlHoCVADarciC42TugAsSHuQOWkv/TqBlbEqh1vMvEuCqKmllka74Sf9SQMAzEvpgHReG6l9GtcmQ7gkbyUtybWQAQK+DX/+5nYavosC075ATydYUrRE7cEb8CXBHw3ZdZR51Zehe+k8O9DZt1dVk3U1ZV4uybXqjofwsyMHFxfvGbgXDsiM9nTvG1RtYKLEyRDO7r0NNnEYnDeWfdNr0LTaa2UoyqPMaTCwsdpBrVBqYOAWNQneRB8bR3kMbh9KJMLUZJGTd56LVHhOn0hEjRYr8mQ53xuhsSKRiuDtZ5mLREhOdo2+FImw9EcjLeUi9bahRLispApFuhF+XbOc85bJkggvveKFWUjXeS622+soT86/NvmahR7ChWhpz4+wrpXMgrmj3x0TbtPTVlt2xkty/C9k8Tkj/hU2bJPotNTF55smL8j3ZKT2VJDtCc3bvfA67mX+32KjvEhPxtvW2PtorF5/uA3hO7Rgm+xWdKOU4BB08G9a8S2bFfeYm98p8wdhXrTOXT+w6zIGUjw8lO06VCYnxfSB4PLuRA1FIugeq5qhNnsfRDh3MjAOECw5QpuVUGNNFoyG2TmQL2XGRGrjLX4t0UNuYG2aVg3emMYDWi9vZSZRAYdVKVmQzugH8ScJOBlv+cM+u9poFzM6HY/569C3qybLyLnbRsFlu1m8mDNd6p6izDzkJhE36Cj/HLGkp8o9hpL5SznAxyL5alPi85dpmvP6X0jaRNCSK0SO/sU2nTECvGWELx2CoPThGXiH2eMDMAtVMBRB4BoZaNlx60n2l4TKlxlagly6rHGO0Q6dFNPx9HgwngwmJ/PJOH01Tsfj37g+cjWdTF/R8cnp9wP6+z9uBpNp/mqAxyeng+Pp6enkePL98Xg8Fl2qxeycj1pn41652EUhNK1+WNBaXPdI8Zp5CR90vywtrreJ0LT6vCv6fdI+TMxTyD/RCj7su0Yf/SVZ6h3Vh6UqPvjaWrU/iYvNLugviGnSSh+fnO6lz7u8U86lrldJHCh0HlZEd3uo0B4DmQ/DvWAzSnRQWEIPteHSxHVwVZKOxrVclDcqVvWoP6bTaKjW0OicrPOoc6mLBKJjCN6idjwQIM8e4CkrtVGmWA+HQ9EW0ePp9HHd/AWVzIMvcGatsS8vmjl5lOqZUqhMdvD0K8pC13i3109T8sJEA5m1lSueK5bvyTksqF8vn9oaggGxMn6B2exXVN3u67F8H94Y3afdeBvD92fKui3/nM8/PgKMua3Il4aJW5vQ+MNIlooR1nK0nIwCJd1o001u21E34XFWL/eD19l/WfvnCfPWhEQdzIzvqTJ2DbOP549Kxyc9A09VbSyqgaMKtZcZVFHArZ2nKnjCJzmEBTzbGqfsBGw358cx2YY7jgOzJBtBJMULyTffwDtC31hy/PcIjo5eo8/KzrYrbywWdHSUhp8EVaO8rBXtYIBuORSkvVrDSvoSsPGGj3AWGxXFa4A0Lf5V581VyABDv5PByPbmskOONyzN5qEChbposIhXGsn2Mhq3yMBweCeVJz4AwdiYXcysce7BpSzEPlr04I4Gjviy4EmtI3q8AZ615ZqBfyTNdwx6fO9xcNOVuMNLYVDRORVxf7RYl/CLdA0q+e9wEhj8XHsKsVpSl+si7Fz2d0aItyZrKlYzt5jdtW6H31Efao5Vi5K3m13MUFM7sh5cU9fG+pYHM5uV0lPGZOCleUkd0xpHLv2kBxyRlpRwIfWdY51vjNaU9dIWmMiDRqaMozCjyIqi+C75j8Q7kqNSa3CykgptL2osfBbD+QXN7Cd3Ar4vOqwIQhZ2IFe1JeS+AzMO9EHs40H23IiWZB3Gnt3GsD1TqOJllT9tn+EpLd1dLLuTE0LHtVLJjHg82G+Z1ZiVBNMhT0yNVTyfeV+7dDRarVZDDI+HxhajVtaNLs7fnP10dTaYDsfD0leKgdnGWC4mw/FwzEtcOSvUPV37lxhFR93I14c1Z7Pvmf9/8/G/9uaj7bYsNgoITIbArE3bRhcCaykSsZyIJE53LJf2XoPEbnqdiJLbb7oQmw1XtJ+t2m55ue2Ki+tELNFKvOFWttiIXDr+nYv0FpWjZ2j17WU7cXwHT9ncDRaax4olqob/iUTc0br/0ibMUiVhTjbYEB+/iZoGYeLZiz8aAHk4ixKzLKPaP7v3ujeYfPxwNReJuGnf7vBcL1JhccXTFK6iqSZ4HqbDsLYRXesSqYiY/PkPrl8Qiw==
sidebar_class_name: "post api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Think and generate answer"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/memory banks/{agent_id}/think"}
context={"endpoint"}
>
</MethodEndpoint>
Think and formulate an answer using memory bank identity, world facts, and opinions.
This endpoint:
1. Retrieves agent facts (memory bank's identity)
2. Retrieves world facts relevant to the query
3. Retrieves existing opinions (memory bank's perspectives)
4. Uses LLM to formulate a contextual answer
5. Extracts and stores any new opinions formed
6. Returns plain text answer, the facts used, and new opinions
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query"},"thinking_budget":{"type":"integer","title":"Thinking Budget","default":50},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"}},"type":"object","required":["query"],"title":"ThinkRequest","description":"Request model for think endpoint.","example":{"context":"This is for a research paper on AI ethics","query":"What do you think about artificial intelligence?","thinking_budget":50}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"text":{"type":"string","title":"Text"},"based_on":{"items":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"text":{"type":"string","title":"Text"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"event_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Date"}},"type":"object","required":["text"],"title":"ThinkFact","description":"A fact used in think response.","example":{"context":"healthcare discussion","event_date":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","text":"AI is used in healthcare","type":"world"}},"type":"array","title":"Based On","default":[]},"new_opinions":{"items":{"type":"string"},"type":"array","title":"New Opinions","default":[]}},"type":"object","required":["text"],"title":"ThinkResponse","description":"Response model for think endpoint.","example":{"based_on":[{"id":"123","text":"AI is used in healthcare","type":"world"},{"id":"456","text":"I discussed AI applications last week","type":"agent"}],"new_opinions":["AI has great potential when used responsibly"],"text":"Based on my understanding, AI is a transformative technology..."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/update-bank-disposition.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: update-bank-disposition
title: "Update memory bank disposition"
description: "Update bank's disposition traits (skepticism, literalism, empathy)"
sidebar_label: "Update memory bank disposition"
hide_title: true
hide_table_of_contents: true
api: eJztV8tu2zoQ/RViNjcBWL9yuxHQRdoEaIC0DfK4m8AoaGlssaFIlaTsGIb+vRhSjqQojyK4q6JeyeLM8MzwnCNpBxm61MrSS6MhgZsyEx7ZQui7fxzLpCuNk7TGvBXSO3bg7rD0MpWu4ExJj1aocI1FKXy+PQQOpkQrKOksgwSqUPI7lfzeKQgcSmFFgR6tg+R2B1oUCAmEQJkBB0mIqCpwsPizkhYzSLytkINLcywEJDvw25LSnLdSr4CDl17RjY9C37GzDOp6HtPR+Y8m21LO42qp0R61pyVRlkqmAf74h6Oh7DqblZaa8xId/eu2M1hsB9VBKbXHFVrgUIh7WVQFJO85FFLH62kL/6pN548O6bPZsKa6UGztmLeV81Kv2MH0w/6as/cfHoIOoebQntabAJ236U8BaqqrLfOGUVVbWvRM6qWxRRgnoVsqvJcLhYSuyQjYGva8Cdhpk/sUqqJKcwKUGu1khpZhYWhZKBbO/N4Tqgy9SHPMCFVEgl6mh1DXfA/HLH5g6ntEvO0ecW+8bT/zFuZJS5broKUB4JOh3HwuwgxVhTpFllNLWBgr0TFhkdFwMWNCZ+3MMRsRgntRlLTxrh3uUZ8ER7xH0qP6tX67fO90Fk2jg/4yqm3QYHOfFSZDRdhZMAdi7tBqRlAHQBZdabSLoppNJkF4vbJXVZqic8tKscsmGN6s6b39/I6z8Mazng/9Sus1/+sUf53iz3IKDguR3q2sqfQrWnmIem1G7YM/qKovmt5+874WL6xZSoUd7T+2nbjQ8R3ai5Ux79EMun3BGRMFE8yZpd/QFFGvpEa0bCN9zqYTtkVhHTNLhvclWhlmLzVzXlhflS7gbgwFKod2OjuCgR389tj3hgPHSqYYDLLm8O9sNjTF/4SSWVTTqbXGvt0RifNS0ZX0WLhhgDJpb1Xo7bdleKXrs6LmA83W85YUwlqx7VDn3ESApPrCrV5i2Rd0TqyC08aQ50PDMNg1rb5GSOorbt3EdXjXjjdO9/k2TuL4ntpsH/L5+vpiUDCebYE+N0SesvLhldnnkMB4PR1nuBSV8mPilxvvGprV44bVwIEO9rJ98T1tOf5W/tX0Ur40Yb577FJnTq5yz6gLdnxxNrTXZiEo7yG+IaRIAyEbXn8hy9qyq63zWMRHUYqk6TbkuCQHZrPRBDhUVkECufelS8bjzWYzEmF5ZOxq3OS68fnZp9OvV6fvZqPJKPeFosJrtC7Cm44mowndKo3zhdCdvZrPoSKiCqbRN6Veo7tWYf/Ph1TDF3r4jEslZJBCaHnXMOEW1tMAI3ChcRtynaR10z0h5hxy4zwl7XYL4fDGqrqm2z8rtFtIbucc1sJKsaCTvQ00oesMkqVQDl9o9+Cy0c0hew73Xh6axLEWqqJ/wOEOt52vvmAIOYoMbYAQVz/Fjd4F2bbZAxcjh4kZx2mKpX8xdt5R18XNNQ2v+Tyk5wQkYMWGHEFsIlAT+g4OF+7tQAm9qsh3Eogl6fcLCGZRRA==
sidebar_class_name: "put api-method"
info_path: docs/api-reference/endpoints/hindsight-http-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Update memory bank disposition"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/v1/default/banks/{bank_id}/profile"}
context={"endpoint"}
>
</MethodEndpoint>
Update bank's disposition traits (skepticism, literalism, empathy)
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"disposition":{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}}},"type":"object","required":["disposition"],"title":"UpdateDispositionRequest","description":"Request model for updating disposition traits."}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"bank_id":{"type":"string","title":"Bank Id"},"name":{"type":"string","title":"Name"},"disposition":{"properties":{"skepticism":{"type":"integer","maximum":5,"minimum":1,"title":"Skepticism","description":"How skeptical vs trusting (1=trusting, 5=skeptical)"},"literalism":{"type":"integer","maximum":5,"minimum":1,"title":"Literalism","description":"How literally to interpret information (1=flexible, 5=literal)"},"empathy":{"type":"integer","maximum":5,"minimum":1,"title":"Empathy","description":"How much to consider emotional context (1=detached, 5=empathetic)"}},"type":"object","required":["skepticism","literalism","empathy"],"title":"DispositionTraits","description":"Disposition traits that influence how memories are formed and interpreted.","example":{"empathy":3,"literalism":3,"skepticism":3}},"background":{"type":"string","title":"Background"}},"type":"object","required":["bank_id","name","disposition","background"],"title":"BankProfileResponse","description":"Response model for bank profile.","example":{"background":"I am a software engineer with 10 years of experience in startups","bank_id":"user123","disposition":{"empathy":3,"literalism":3,"skepticism":3},"name":"Alice"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

71
hindsight-docs/docs/api-reference/endpoints/update-bank-personality.api.mdx
View file

@ -1,71 +0,0 @@
---
id: update-bank-personality
title: "Update memory bank personality"
description: "Update memory bank's Big Five personality traits and bias strength"
sidebar_label: "Update memory bank personality"
hide_title: true
hide_table_of_contents: true
api: eJztWEtv2zgQ/isEe9g2UGwn3Rd0c9qkDdBHkKS9NEExkcYyG4pUyZEdr+H/vhhSsmS7SXezC+wemktkcd6c+T6KS0lQeJl+kuMCDYm3YKDAEg3J60Tm6DOnKlLWyFR+qHIgFMCCP3lxpApxomYoKnTeGtCKFoIcKPICTC5uFHjhyaEpaCoTaSt0wKZOc5nKOhj7HIx97lmQiazAQYmEjuNaSgMlylRGSZXLRCqOpoJg1eHXWjnMZUquxkT6bIolyHQpaVGxnienTCETSYo0v4iJnuZytbqO+ujpyOYLVto2l1lDXIx0KaGqtMpCBsMvniuy7HmrHOdHCn341UtoZ9FWaAx63wvS1OUNOpnIEu5UWZcyPUhkqUx8HnXBv291tzenXRBkBd5V6BSaDMXT0f7BM7kKifhMoSFla/9Y7y92jGyHsSPRRYB35GCGzqtYu7/r/Livv+23v9i5hMIhwo3GxyY83jCw7XRjtfNqsHaWVKZ8+Rif73rq2x57a50/HrTP60F7hMcjntSLblI3fb62cx5jawq92Jh1ZSa65i7zwlbKKGvWRVglbRD25gtmtDGon7oJ+FZfbnXK9i5u1nc7++suq7Mu1MuASjuZne0C1w14zIU1HbqVNkc9CFFBWbHl5XZfjQa/7exCePeNoRsNft0ehdHgl62mGQ2eJz2YGA1+X32vpH3E6RUhYnYv0fOIdzu1aN7HdMXEOhEQWpniG/g+kKsQkENfWeMjrB2ORvxv0+xFnWXo/aTW4rwRlo9G1TUF/CV0TxrmuF/2Ha+vkh9o/QOtf6D1D7T+N9E6kTeQ3RbO1uZBuDrqpL63Db0DcAC2TdzacHi9hYdnzk6Uxh4Cb4N/XOihf/Amqqi4U9AWh2Xt0R0cPt90n8pTAaUA4e2E5uBQoCmUQXRirmgqDkZigeC8sJM++ikjPIGjuvJtjqkca5Vt5/pfMXDgvJ8PD3dp7iNolQcSE8fOWfd4jsuRQGl+UoSl3xXQNttYBbN4PwkfSps9tkrWb5QhLNDJ1XXXYuAcLHqN+MbGABmiSl881LNv0XsoAnNGkftFQzHEJa9+r705r+i6kes1cVfeWN3703gZy/ctZ63I68vLsx2DcW9LpKnl/q1qCh+i3EdyCJUazg6Goe39cNm2/2rYjIdMJG/refcpedwNy/+gcfmLeWLDPm2ckt5iad1CjM9OdxDhyowFYVlZB3rfYwmGVCbKqOAXnrAMMDE+jUjhBU2BhCfr0CfCITmFM37kqwCH4Jlv7AxdNKLQD67MlXnyRJwgUO3Q8889sbd3BJRN29guyDoocG8vDY8oylqTqjSuzQicTFSolF5EeIGabAkc7wQyEqFiGecV7V+02VwguGzKpk9UCFLjDAx1lmvPx1/D4YEWGkxRQ4Hia82I5aO1E3bBDS5OlCbk/g/BBtsCMme9F3PrdB6i4YKE2seImvqsCdkjX34Q6kW0fjlV5lYcm7yyyhAbfoWGr1FQBHy5oxq0AOPn6Hp0GF2onNuHFsFFm1S0+8pBNRUfla9Bqz/CILDxU0MYajXDdq+LIDnrS0YTL21W8z2RuHSQ3TZph+foL1wktVbyRtjHHaorj46Er6vKOmr6YOyyqSLMuBn41eUU206rPfr0yuxzRZqmFG+UufXs84U1BrPetoVOZNbJtPWBVkiVGNXXm7+j3jY5aL0QXpVKg+tVjZWPYzm/47kMQ2sEcfxQMvmRorWRi8oh5NxYYy70Ru21VmHnmhGHSMVNDZuZAn1lRPPX0AxkgWYaxmwnJ5SOoZIZlFm/ExlXkE1RHA5GMpG10zKVU6LKp8PhfD4fQFgeWFcMG10/fHP64vjdxfH+4WA0mFKp2fAahuTBYDQYhU8p66kE0/PVvzUUmyeWDchZdoz5T28aG+Tn8RhWGlQgtZDmssH0TxIqJRM5OwgnVu5Mmci0d8Rqof06kVPriVWWSx6wD06vVvyaYWAh00/XiZyBU4zpgYZz5fk5l+kEtMcH0nx63vDfM3Ff1C3NGa7XDHTNv2Qib3HRvxMNzD5FyNGFGOLyi+hpP/Bvp75zHOGjQtQYZxlW9KDsdY8mzz5c8smvuTvlw6NMpYM5UzvMY6Q2JB6OKuHdUrZAKlMZTfLfn1YV03o=
sidebar_class_name: "put api-method"
info_path: docs/api-reference/endpoints/agent-memory-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Update memory bank personality"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/api/v1/memory banks/{agent_id}/profile"}
context={"endpoint"}
>
</MethodEndpoint>
Update memory bank's Big Five personality traits and bias strength
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"bank ID"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"personality":{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}}},"type":"object","required":["personality"],"title":"UpdatePersonalityRequest","description":"Request model for updating personality traits."}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"agent_id":{"type":"string","title":"bank ID"},"name":{"type":"string","title":"Name"},"personality":{"properties":{"openness":{"type":"number","maximum":1,"minimum":0,"title":"Openness","description":"Openness to experience (0-1)"},"conscientiousness":{"type":"number","maximum":1,"minimum":0,"title":"Conscientiousness","description":"Conscientiousness (0-1)"},"extraversion":{"type":"number","maximum":1,"minimum":0,"title":"Extraversion","description":"Extraversion (0-1)"},"agreeableness":{"type":"number","maximum":1,"minimum":0,"title":"Agreeableness","description":"Agreeableness (0-1)"},"neuroticism":{"type":"number","maximum":1,"minimum":0,"title":"Neuroticism","description":"Neuroticism (0-1)"},"bias_strength":{"type":"number","maximum":1,"minimum":0,"title":"Bias Strength","description":"How strongly personality influences opinions (0-1)"}},"type":"object","required":["openness","conscientiousness","extraversion","agreeableness","neuroticism","bias_strength"],"title":"PersonalityTraits","description":"Personality traits based on Big Five model.","example":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}},"background":{"type":"string","title":"Background"}},"type":"object","required":["agent_id","name","personality","background"],"title":"AgentProfileResponse","description":"Response model for memory bank profile.","example":{"agent_id":"user123","background":"I am a software engineer with 10 years of experience in startups","name":"Alice","personality":{"agreeableness":0.7,"bias_strength":0.7,"conscientiousness":0.6,"extraversion":0.5,"neuroticism":0.3,"openness":0.8}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>

1983
hindsight-docs/openapi.json
View file

File diff suppressed because it is too large Load diff

2
openapi.json
View file

@ -1042,7 +1042,7 @@
},
"delete": {
"summary": "Clear memory bank memories",
"description": "Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality and background) will be preserved.",
"description": "Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.",
"operationId": "clear_bank_memories",
"parameters": [
{

18
scripts/generate-openapi.sh
View file

@ -1,13 +1,25 @@
#!/bin/bash
set -e
# Script to generate OpenAPI specification
# This runs the generate-openapi command from hindsight-dev
# Script to generate OpenAPI specification and update documentation
# This runs the generate-openapi command from hindsight-dev and regenerates docs
cd "$(dirname "$0")/.."
ROOT_DIR=$(pwd)
echo "Generating OpenAPI specification..."
cd hindsight-dev
uv run generate-openapi
echo "OpenAPI spec generated successfully!"
echo ""
echo "Copying OpenAPI spec to documentation..."
cp "$ROOT_DIR/openapi.json" "$ROOT_DIR/hindsight-docs/openapi.json"
echo ""
echo "Regenerating API reference documentation..."
cd "$ROOT_DIR/hindsight-docs"
npx docusaurus clean-api-docs hindsight
npx docusaurus gen-api-docs hindsight
echo ""
echo "OpenAPI spec and documentation generated successfully!"