Retrieve, Update, or Delete RAG Document | AISquare Studio

import requests
url = "https://api.example.com/api/v1/content-vault/documents/1/"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.put(url, data=payload, headers=headers)
print(response.json())

{
  "document_id": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-04-10T14:45:00Z",
  "file_type": "application/pdf",
  "file_size": 254000,
  "user": "jdoe",
  "upload_status": "uploaded",
  "has_file": true,
  "status_message": "File uploaded successfully",
  "description": "Detailed project plan for the second quarter of 2024.",
  "owner": {
    "id": 42,
    "email": "jdoe@example.com",
    "full_name": "John Doe",
    "username": "jdoe",
    "is_verified": true,
    "profile_picture": "https://example.com/profiles/jdoe.jpg"
  },
  "progress": 100,
  "document_name": "Project Plan Q2 2024",
  "document_type": "file",
  "content": "This document outlines the project milestones and deliverables for Q2 2024."
}

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

* `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)

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

* `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