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>"
}
'import requests
url = "https://pria.praxislxp.com/api/user/collection/{id}/files"
payload = {
"lean": True,
"compact": True,
"page": 123,
"pageSize": 123,
"fileNameSearch": "<string>",
"nameOrder": True,
"sortAscending": True,
"sortBy": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lean: true,
compact: true,
page: 123,
pageSize: 123,
fileNameSearch: '<string>',
nameOrder: true,
sortAscending: true,
sortBy: '<string>'
})
};
fetch('https://pria.praxislxp.com/api/user/collection/{id}/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/user/collection/{id}/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lean' => true,
'compact' => true,
'page' => 123,
'pageSize' => 123,
'fileNameSearch' => '<string>',
'nameOrder' => true,
'sortAscending' => true,
'sortBy' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/user/collection/{id}/files"
payload := strings.NewReader("{\n \"lean\": true,\n \"compact\": true,\n \"page\": 123,\n \"pageSize\": 123,\n \"fileNameSearch\": \"<string>\",\n \"nameOrder\": true,\n \"sortAscending\": true,\n \"sortBy\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/user/collection/{id}/files")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"lean\": true,\n \"compact\": true,\n \"page\": 123,\n \"pageSize\": 123,\n \"fileNameSearch\": \"<string>\",\n \"nameOrder\": true,\n \"sortAscending\": true,\n \"sortBy\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/collection/{id}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lean\": true,\n \"compact\": true,\n \"page\": 123,\n \"pageSize\": 123,\n \"fileNameSearch\": \"<string>\",\n \"nameOrder\": true,\n \"sortAscending\": true,\n \"sortBy\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"_type": "collection",
"fileCount": 123,
"totalSize": 123,
"includedCount": 123,
"excludedCount": 123,
"subCollectionCount": 123,
"previewFiles": [
"<string>"
]
}
],
"total": 123,
"hasMore": true,
"page": 123,
"pageSize": 123
}Collections
List files within a collection
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>"
}
'import requests
url = "https://pria.praxislxp.com/api/user/collection/{id}/files"
payload = {
"lean": True,
"compact": True,
"page": 123,
"pageSize": 123,
"fileNameSearch": "<string>",
"nameOrder": True,
"sortAscending": True,
"sortBy": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lean: true,
compact: true,
page: 123,
pageSize: 123,
fileNameSearch: '<string>',
nameOrder: true,
sortAscending: true,
sortBy: '<string>'
})
};
fetch('https://pria.praxislxp.com/api/user/collection/{id}/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/user/collection/{id}/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lean' => true,
'compact' => true,
'page' => 123,
'pageSize' => 123,
'fileNameSearch' => '<string>',
'nameOrder' => true,
'sortAscending' => true,
'sortBy' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/user/collection/{id}/files"
payload := strings.NewReader("{\n \"lean\": true,\n \"compact\": true,\n \"page\": 123,\n \"pageSize\": 123,\n \"fileNameSearch\": \"<string>\",\n \"nameOrder\": true,\n \"sortAscending\": true,\n \"sortBy\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/user/collection/{id}/files")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"lean\": true,\n \"compact\": true,\n \"page\": 123,\n \"pageSize\": 123,\n \"fileNameSearch\": \"<string>\",\n \"nameOrder\": true,\n \"sortAscending\": true,\n \"sortBy\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/collection/{id}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lean\": true,\n \"compact\": true,\n \"page\": 123,\n \"pageSize\": 123,\n \"fileNameSearch\": \"<string>\",\n \"nameOrder\": true,\n \"sortAscending\": true,\n \"sortBy\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"_type": "collection",
"fileCount": 123,
"totalSize": 123,
"includedCount": 123,
"excludedCount": 123,
"subCollectionCount": 123,
"previewFiles": [
"<string>"
]
}
],
"total": 123,
"hasMore": true,
"page": 123,
"pageSize": 123
}Authorizations
JWT token passed in authorization header
Path Parameters
Body
application/json
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
excludedexpands tostatus $nin:['selected','deleted']. - Pseudo-value
processingmatches files currently mid-ingestion (ingestion.phase ∈ {extract, chunk, sanitize, embed, kag}ANDstatus $ne:'deleted'). When omitted, defaults to $ne:'deleted'.
Available options:
inactive, selected, active, error, deleted, excluded, processing Response
200 - application/json
Paginated list of files in the collection, plus child sub-collections
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).
Show child attributes
Show child attributes
Direct child sub-collections with stats
Show child attributes
Show child attributes
Was this page helpful?
⌘I