List and Create RAG Documents | AISquare Studio

curl -X POST /api/v1/content-vault/documents/ \
     -H "Content-Type: multipart/form-data" \
     -F document_type="file"

{
  "document_id": 1024,
  "created_at": "2024-04-10T14:22:00Z",
  "updated_at": "2024-04-12T09:15:00Z",
  "file_type": "application/pdf",
  "file_size": 245760,
  "upload_status": "uploaded",
  "status_message": "File uploaded successfully",
  "linked_experiences_count": 3,
  "linked_experiences": [
    {}
  ],
  "has_file": true,
  "description": "Quarterly project plan document for internal use.",
  "workspace": "Marketing Team Workspace",
  "workspace_id": 15,
  "owner": {
    "id": 42,
    "email": "jane.doe@aisquare.com",
    "full_name": "Jane Doe",
    "username": "janedoe",
    "is_verified": true,
    "profile_picture": "https://aisquare.com/profiles/janedoe.jpg"
  },
  "progress": 100,
  "document_name": "Project Plan Q2",
  "document_type": "file",
  "document_url": "https://storage.aisquare.com/docs/project_plan_q2.pdf",
  "content": "Detailed project plan for Q2 including milestones and deliverables."
}

List all RAG documents for the authenticated user with pagination. Supports search, filtering and multiple ordering patterns. POST supports creating new documents with file upload capabilities.

Query parameters

file_typestringOptional

Filter by document_type

orderingstringOptional

Comma separated ordering fields (updated_at, document_name) prefix with - for desc

qstringOptional

Full-text search across document fields

sortstringOptional

Shortcut ordering: latest | oldest | name_asc | name_desc

statusstringOptional

Filter by upload_status

Request

This endpoint expects a multipart form.

document_namestring or nullOptional

namestringOptional

Alias for document_name

document_typeenumRequired

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

document_urlstring or nullOptional

contentstring or nullOptional

configany or nullOptional

document_filestringOptionalformat: "uri"

document_fileslist of stringsOptional

Multiple files to upload (alternative to document_file)

workspacestringRequired

workspace_idintegerOptional

ID of workspace. Optional if X-Workspace-Id header or workspace cookie sets context

Response

List of user's documents

document_idintegerRead-only

created_atdatetimeRead-only

updated_atdatetimeRead-only

file_typestring or nullRead-only

file_sizeinteger or nullRead-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:

status_messagestring or nullRead-only

Human-readable status / failure message for ingestion

linked_experiences_countintegerRead-only

linked_experienceslist of maps from strings to anyRead-only

has_filebooleanRead-only

descriptionstringRead-only

workspacestringRead-only

workspace_idintegerRead-only

ownerobject

Owner/uploader user object

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

document_urlstring or null

contentstring or null

configany or null

Errors

400

Bad Request Error

401

Unauthorized Error