Retrieve, Update, or Delete RAG Document

DELETE

https://host.com/api/v1/content-vault/documents/:document_id/

DELETE

/api/v1/content-vault/documents/:document_id/

$ curl -X DELETE /api/v1/content-vault/documents/1/ \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "document_id": 1,
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "file_type": "pdf",
6   "file_size": 245760,
7   "user": "jane.doe@example.com",
8   "upload_status": "importing",
9   "has_file": true,
10   "status_message": "File upload in progress",
11   "description": "Detailed project proposal document for Q2 planning.",
12   "owner": {
13     "id": 42,
14     "email": "jane.doe@example.com",
15     "full_name": "Jane Doe",
16     "username": "janedoe42",
17     "is_verified": true,
18     "profile_picture": "https://example.com/media/profile_pics/janedoe42.jpg"
19   },
20   "progress": 35,
21   "document_name": "Project Proposal Q2",
22   "document_type": "file",
23   "content": "This document contains the detailed project proposal for Q2 initiatives."
24 }

Retrieve detailed information about a specific document, update its content, or delete it. All operations are restricted to the document owner.

Path parameters

document_idintegerRequired

Document ID

Response

Document details

document_idintegerRead-only

created_atdatetimeRead-only

updated_atdatetimeRead-only

file_typestring or nullRead-only

file_sizeinteger or nullRead-only

userstringRead-only

upload_statusenum

importing - Importing
vectorizing - Vectorizing
summarizing - Summarizing
uploaded - Uploaded
failed - Failed

Allowed values:

has_filebooleanRead-only

status_messagestring or nullRead-only

Human-readable status / failure message for ingestion

descriptionstringRead-only

ownerobject

Simple user serializer with profile picture from associated IAMUserDetail.

Fields:

id, email, full_name, username, is_verified (from IAMUser)
profile_picture (from first related IAMUserDetail if present)

progressintegerRead-only

Processing progress as percentage (0-100)

document_namestring or null

document_typeenum

file - File
url - URL
user - User
text - Text
youtube - YouTube
gdrive - Google Drive
email - Email
rss - RSS Feed

contentstring or null

configany or null

Errors

401

Unauthorized Error

404

Not Found Error