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: eJy9Vk1v2zgQ/SvEnHYBRZLd9qJbNs2mAdpt0Th7WMMwaGkssaFIlaScGoL+ezGUZMlx4g2Kxfoii3zz9eYNqQYczy0kS3iv07pE5SysAsjQpkZUTmgFCdygY5zZClOxFSnLeiQTKpV1JlTOhLNMG5ELxSVz+MNBALpCw8nDbQYJ5OjWgyEEUHHDS3RoKHYDipcICWy4eliLDAIQFLfiroAADH6vhcEMEmdqDMCmBZYckgbcviIz64xQOQTghJO08AdXD+w2g7YNDr6H4P+F/4GrLsaKXNhKK4uWrOZxTI9jDu/qNEVrt7VkX3swBJBq5YiQpAFeVVKknrDomyWbZpJJZYhOJ7oIIjuXHSUVHLh8DU0BDM1b++adsfk8dHlBwPZQwrrgtvB1qP3nrW/qsQtqRb+iaimBaBucXnU+2AfyQT4NcofZmp9N5apDsUufR11lr7C571C9TYmlNvt1rYRbp7pWU1OhHOZoJrafPJrdK+HYlUe3bTDA9eYbpu5ITUvwUhtFfUzyE+qOqj4q57k8V6dinMjqWHrDBit1hpJttWE5unGMUWWVFsqFEAD+4GVFbptRQFBbNLP5m6cZJ8A3ab8+aRjM4/nbi3h2MXu3mMXJmziJ439o5MiVRWuFVuvZs1Uls3cnUoQ/aynHZGmRFWgwDMNjml4I3NIvgLfz+elQ/s2lyPzIsWtjtPn1iczQcSH9bDos7SlA6vRo9xVjMiiwXY0y48bw/USTH3WXoFezzc9J/xNay3OEg7OXoZ4MtqDdf5M41dWF7nETZY70duy+XMb7jr7ngg2QD4vFlxOHXW9LdIXuLxl/tzgSZ7SbRRlueS1dRFq2UdNLuo0GOdmomdwLrb8YttpTM4QVKrMiLxyjBNjll9uT+Ro2/GQd8L2WeOq11F9C/RFyt7cOS+JDihRpZkfIZcXTAtk8jEneRkIChXOVTaLo8fEx5H471CaPelsbfby9uv7r7vpiHsZh4UpJjndobJfeLIzDmJYqbV3J1STWzfQY6CRsn5bXjCPxix8CfUfpLaokF16svrKm79USdjMf13erPzMpk2Q8PA8to+XpZb4KoNDWkZem2XCL90a2LS1/r9HsIVmuAthxI/iGOrpsIBOW/meQbLm0eKbg3772Uv+dvVTIoGhFet5xWdMbBPCA+8kXDY31/xh2yo8/PgrkGRpffYe4TFOs3MT25LSjC/owWTfXC2jbn+gTcts=
|
|
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>
|
|
|
|
|
|
|