API Documentation
Quiz Submissions Multiplayer
Quiz Submissions Singleplayer
Share
Documents
Documents
Upload a document
Upload a document to the database
POST
/
api
/
v1
/
documents
/
upload
curl --request POST \
--url http://localhost:8787/api/v1/documents/upload
{
"success": true,
"message": "<string>",
"data": {
"id": 123,
"fileName": "<string>",
"fileType": "<string>",
"uploadDate": "<string>",
"size": "<string>",
"status": "<string>",
"metadata": {
"size": 123,
"mimeType": "<string>",
"sizeInKb": 123,
"extension": "<string>",
"uploadedBy": "<string>",
"contentType": "<string>",
"storagePath": "<string>",
"lastModified": "<string>",
"originalName": "<string>",
"signedUrlExpiry": "<string>",
"uploadTimestamp": "<string>",
"processingStatus": "<string>"
}
}
}
Response
201 - application/json
Document uploaded successfully
The response is of type object
.
curl --request POST \
--url http://localhost:8787/api/v1/documents/upload
{
"success": true,
"message": "<string>",
"data": {
"id": 123,
"fileName": "<string>",
"fileType": "<string>",
"uploadDate": "<string>",
"size": "<string>",
"status": "<string>",
"metadata": {
"size": 123,
"mimeType": "<string>",
"sizeInKb": 123,
"extension": "<string>",
"uploadedBy": "<string>",
"contentType": "<string>",
"storagePath": "<string>",
"lastModified": "<string>",
"originalName": "<string>",
"signedUrlExpiry": "<string>",
"uploadTimestamp": "<string>",
"processingStatus": "<string>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.