Skip to main content
POST
/
api
/
user
/
collection
/
{id}
/
files
List files within a collection
curl --request POST \
  --url https://pria.praxislxp.com/api/user/collection/{id}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lean": true,
  "compact": true,
  "page": 123,
  "pageSize": 123,
  "fileNameSearch": "<string>",
  "nameOrder": true,
  "sortAscending": true,
  "sortBy": "<string>"
}
'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "filename": "<string>",
      "originalname": "<string>",
      "mimetype": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "filesize": 123,
      "thumbnail": "<string>",
      "user": "<string>",
      "institution": "<string>",
      "account_shared": true,
      "file_summary": "<string>",
      "file_title": "<string>",
      "file_url": "<string>",
      "tokens_used": 123,
      "is_public": false,
      "is_private": false,
      "file_dimensions": "<string>",
      "file_authors": "<string>",
      "embeddings_model": "<string>",
      "summary_model": "<string>",
      "image_analysis_model": "<string>",
      "googleDriveFileId": "<string>",
      "googleDriveModifiedTime": "2023-11-07T05:31:56Z",
      "ragHitCount": 0,
      "lastRagHitAt": "2023-11-07T05:31:56Z",
      "vaultHealthScore": 123,
      "fileOnDisk": true,
      "owner_data": {
        "email": "jsmith@example.com",
        "fname": "<string>",
        "lname": "<string>",
        "institution": "<string>"
      },
      "institution_data": {
        "name": "<string>",
        "ainame": "<string>"
      },
      "institution_name": "<string>",
      "institution_display_name": "<string>",
      "index": 123,
      "collection": "<string>",
      "collection_path": [
        {
          "_id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "childCollections": [
    {
      "_id": "<string>",
      "name": "<string>",
      "user": "<string>",
      "institution": "<string>",
      "account_shared": true,
      "parent": "<string>",
      "color": "#3b82f6",
      "created": "2023-11-07T05:31:56Z",
      "fileCount": 123,
      "totalSize": 123,
      "includedCount": 123,
      "excludedCount": 123,
      "subCollectionCount": 123,
      "previewFiles": [
        "<string>"
      ]
    }
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT token passed in authorization header

Path Parameters

​
id
string
required

Body

application/json
​
lean
boolean
​
compact
boolean
​
page
integer
​
pageSize
integer
​
fileNameSearch
string
​
status
enum<string>

Filter the collection's files by status. Mirrors the shape used by /api/user/uploads:

  • Real DB values (inactive/selected/active/error/deleted) match exactly.
  • Pseudo-value excluded expands to status $nin:['selected','deleted'].
  • Pseudo-value processing matches files currently mid-ingestion (ingestion.phase ∈ {extract, chunk, sanitize, embed, kag} AND status $ne:'deleted'). When omitted, defaults to $ne:'deleted'.
Available options:
inactive,
selected,
active,
error,
deleted,
excluded,
processing
​
nameOrder
boolean
​
sortAscending
boolean
​
sortBy
string

Response

200 - application/json

Paginated list of files in the collection, plus child sub-collections

​
success
boolean
​
data
object[]

Array of UploadFile objects. In lean/compact mode, each file is enriched with owner_data (for instance/account files), institution_name, and institution_display_name (for account_shared files).

​
childCollections
object[]

Direct child sub-collections with stats

​
total
integer
​
hasMore
boolean
​
page
integer
​
pageSize
integer