71 lines
No EOL
4.2 KiB
Text
71 lines
No EOL
4.2 KiB
Text
---
|
|
id: list-documents
|
|
title: "List documents"
|
|
description: "List documents with pagination and optional search. Documents are the source content from which memory units are extracted."
|
|
sidebar_label: "List documents"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzFVk1v4zYQ/SvEnFpAsSRvctEt7QatgWw33bg9NDAMWhpb3FCkQo6SGIb++4IUJUubOGmLAvXFNvk4bz7eDHkA4jsL2R181HlToSILqwgKtLkRNQmtIINrYYkV/T57ElSymu+E4g7AuCqY9lgumUVu8nLGBnOMG2RUIrO6MTmyXCtCRWxrdMWeSpGXrMJKmz1rlAhwfCbDc8JiBhHoGo0nWhSQgRSW1oMvEEHNDa+Q0LgoDqB4hZDBhqv7tSggAuEiqDmVEIHBh0YYLCAj02AENi+x4pAdgPa1O2bJCLWDCEiQdAs/cXXPFgW0bTTYfuitPjRo9hOzWy7txC5X+89b79iUwZkLK6qREtrVkfP3CZsUlaB/wBisCkW4QwOullveSIIsTZIjybU3OybS263F/4ZpxPO5s9q6AA3aWiuL1p2eJ4n7mirttslztHbbSPYlgCGCIBmfz7qWIvdyiL9ad+Yw8qg2TiwkOgZBWE1/8KIQnU5vRshOCyEavfmKOUE7LHBj+H6kiIU35vY1cflqHnro0iPaKNTwLWgoR9RX4S3skNLvnR5X6y5E3fsZDUIKDKsxuaWhX0d5n9am32CVLlCyrTZMTgcDqqLWQpHrWnzmVe2sD+m/OwxdmUFj0aTzD8firktuS5fuTR7WDXLCYs0JMpgn8/OzJD1LL5Zpkn1IsiT5yynVmbJordBqnUIE3SRZu0myznXjNJNeRED4TGuJakclZBfn8ySCpi7eMe8UGwrnO6evTDKU/iJp3SeC8/n8pZb/5FIU3YS8Mkabfy/kAokLOVHyFCB1PtX5+1Onl1W7Oi31a9056HRZ2d1bc/ITWst3eOyb01CfDLZ0u+9J2MXVUQfcSLTH9HbZPR3Gxy59r5H1kF+Xy5sXBrvaVkildjrb+eHob5IM4sc0DuMudqq28SGIu43Ht5NQW+2T0RMJVVixK4k5SnZ5s3jRZ/2G77ABH9TDc6+eMLI/dRfn7d4SVt2gydH17hFyWfO8RDafJRBBYyRkUBLVNovjp6enGffbM212cThr4+vFz1e/3V6dzWfJrKTKT7BHNLZzL50ls8Qt1dpSxdWIa/pO+D6ww1H+//OLIqjATYW4llx4gfvcHEJ97+AxHV1okZ9cLqLs+LAoxg+mUltyxw6HDbf4h5Ft65a7W9Q1YiEs38jRPXqP+/CWeOSycf749jyB64f338EOF/kRvHJ/jHDo1705WakfvoR+/JGdylzfdmo/5uy96RPmB02JvEDjXeh2L/Mc67GvL+ai833owV+ultC23wAYB51G
|
|
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 documents"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/default/banks/{bank_id}/documents"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
List documents with pagination and optional search. Documents are the source content from which memory units are extracted.
|
|
|
|
<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":"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>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<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":[{"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>
|
|
|
|
|
|
|