v1
latestOpenAPI 3.1.02026-07-263580186.3 KBList files accessible to the authenticated user
Retrieve a paginated list of files (documents) accessible to the authenticated user. Results are ordered by upload date (newest first) by default. When using the search parameter, results are ordered by relevance.
Public datasets: instance admins (holding MANAGE_PUBLIC_DATASET) always see public-dataset files. A company that has opted in (allow_access_to_public_datasets) with a workspace-scoped API key granting a public workspace also sees its files — filter with workspace_id to scope the list to it.
Query parameters
[Facet] Filter by attribute value. Repeated attribute entries are ANDed; values inside one entry are ORed with | (pipe is the recommended OR delimiter — comma also works but can be ambiguous with multi-key values). Example: attribute=fiscal_year:2024|2025&attribute=status:active → (fiscal_year 2024 OR 2025) AND (status active). Formats: name (has any value), name:value (exact), name:>value / name:>=value (gt/gte), name:<value / name:<=value (lt/lte), name:prefix* (starts with, case-insensitive), name:*text* (contains, case-insensitive), name:a|b (OR). Smart dates: filing_date:2023 (year), filing_date:2023-06 (month). Type-aware: booleans (true/false), multi-select (membership check). Scoped: content_type(legal:compliance).regulation:AML.
[Facet] Filter by content type path. Multiple values are OR. Exact-or-subtree matching by default (e.g. legal matches legal, legal:contract). Wildcards: *contract* (contains), legal:contract* (prefix).
Filter by created_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?created_at_after=2024-01-01&created_at_before=2024-01-01T23:59:59)
Filter by created_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?created_at_after=2024-01-01&created_at_before=2024-01-01T23:59:59)
Filter by file extensions (comma-separated, e.g., ?extension=pdf,docx)
Filter by external document type (case-insensitive partial match). Only returns documents that have external metadata. Example: ?external_metadata__doc_type=gitlab matches 'gitlab issue', 'gitlab ticket', 'Gitlab MR', etc.
Filter by external document ID (exact match). Matches the doc_id stored in the document's external metadata. Only returns documents that have external metadata. Example: ?external_metadata__external_id=SN-12345
Filter by filename (case-insensitive partial match)
Filter by group IDs (comma-separated, e.g., ?group_id=1,2,3)
Include detail fields (e.g., TLSH signature, parser, summaries, and content type attribute values). Default: false.
Maximum number of documents to return (default: 50, minimum: 1, maximum: 500)
Sort results by field. Prefix with '-' for descending order. Allowed fields: created_at, filename, title, total_pages, size. Default: -created_at (newest first). Ignored when 'search' is provided (results ordered by relevance).
Filter by owner user IDs (comma-separated, e.g., ?owner_id=1,2,3)
A page number within the paginated result set.
Number of results to return per page.
Semantic search query. When provided, results are ordered by combined retrieval score descending. No relevance scoring is applied — scores.relevance is always null in search_details chunks.
When true (and search is provided), include top relevant chunk(s) per document.
Max number of relevant chunks to return per document when search_details=true (1-10, default: 3).
Filter by status values (comma-separated, e.g., ?status=pending,embedded)
Filter by vision status values (comma-separated, e.g., ?status_vision=pending,embedded)
Filter by tag IDs (comma-separated, e.g., ?tag_id=1,2,3)
Filter by title (case-insensitive partial match)
Filter by total pages range (e.g., ?total_pages_min=10&total_pages_max=50)
Filter by total pages range (e.g., ?total_pages_min=10&total_pages_max=50)
Filter by updated_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?updated_at_after=2024-01-01&updated_at_before=2024-01-01T23:59:59)
Filter by updated_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?updated_at_after=2024-01-01&updated_at_before=2024-01-01T23:59:59)
Filter by upload session UUID (e.g., ?upload_session_uuid=123e4567-e89b-12d3-a456-426614174000)
Filter by workspace IDs (comma-separated, e.g., ?workspace_id=1,2,3)
Response
List of files accessible to the authenticated user
Example response
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}