71 lines
No EOL
4.6 KiB
Text
71 lines
No EOL
4.6 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: 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=
|
|
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 document details"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/api/v1/agents/{agent_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":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent 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"},"agent_id":{"type":"string","title":"Agent 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"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|