content-vault

Retrieve, Update, or Delete RAG Document

View as Markdown
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

Request

This endpoint expects a multipart form.
document_namestring or nullOptional
document_urlstring or nullOptional
contentstring or nullOptional
configany or nullOptional
document_filestringOptionalformat: "uri"

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