API Documentation
Quiz Submissions Multiplayer
Quiz Submissions Singleplayer
Share
Documents
Documents
Get a document by ID
Get a document by its ID
GET
/
api
/
v1
/
documents
/
{id}
curl --request GET \
--url http://localhost:8787/api/v1/documents/{id}
{
"id": 123,
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileUrl": "<string>",
"content": "<string>",
"metadata": {
"originalName": "<string>",
"contentType": "<string>",
"extension": "<string>",
"uploadTimestamp": "<string>",
"size": 123,
"sizeInKb": 123,
"lastModified": "<string>",
"storagePath": "<string>",
"mimeType": "<string>",
"uploadedBy": "<string>",
"processingStatus": "<string>",
"signedUrlExpiry": "<string>"
},
"createdAt": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": 123,
"pageCount": 123,
"processingStatus": "<string>",
"lastAccessed": "<string>",
"quizCount": 123,
"embedding": [
123
],
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Path Parameters
Response
200 - application/json
Document retrieved successfully
The response is of type object
.
curl --request GET \
--url http://localhost:8787/api/v1/documents/{id}
{
"id": 123,
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileUrl": "<string>",
"content": "<string>",
"metadata": {
"originalName": "<string>",
"contentType": "<string>",
"extension": "<string>",
"uploadTimestamp": "<string>",
"size": 123,
"sizeInKb": 123,
"lastModified": "<string>",
"storagePath": "<string>",
"mimeType": "<string>",
"uploadedBy": "<string>",
"processingStatus": "<string>",
"signedUrlExpiry": "<string>"
},
"createdAt": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": 123,
"pageCount": 123,
"processingStatus": "<string>",
"lastAccessed": "<string>",
"quizCount": 123,
"embedding": [
123
],
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Assistant
Responses are generated using AI and may contain mistakes.