71 lines
No EOL
4 KiB
Text
71 lines
No EOL
4 KiB
Text
---
|
|
id: get-document
|
|
title: "Get document details"
|
|
description: "Get a specific document including its original text"
|
|
sidebar_label: "Get document details"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
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/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 document details"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/default/banks/{bank_id}/documents/{document_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Get a specific document including its original text
|
|
|
|
<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":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document 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"},"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>
|
|
|
|
|
|
|