files

list_files

List source files with exact totals and access-filtered coverage.

Cost class: fast (structured-metadata predicates only; no index lookup).

The sanctioned completeness instrument: total_count is exact and access-filtered; coverage says how many candidates the access gate withheld and which labels would have been needed. A caller that cannot reconcile total_count with their own ledger knows the gap is labelled content rather than a missing file.

Args: context: Resolved workspace plus the caller's access predicate. session: Database session. path_prefix: Only files whose path starts with this string. ingestion_status: Restrict to these ingestion statuses. categories: Restrict to these categories. file_types: Restrict to these file extensions (e.g. ["pdf", "xlsx"]). modified_after: Only files updated after this timestamp. modified_before: Only files updated before this timestamp. cursor: Opaque keyset cursor from the previous page's next_cursor. limit: Rows per page.

Returns: FileListPage with items, paging metadata, and access coverage.

get/v1/workspaces/{workspace_id}/files

Request

Path parameters

workspace_idstring uuid required

Workspace identifier.

Query parameters

path_prefixstring nullable

Restrict to paths starting with this prefix.

ingestion_statusIngestionStatus[] nullable

Restrict to these ingestion statuses.

categoriesstring[] nullable

Restrict to these categories.

file_typesstring[] nullable

Restrict to these file extensions.

modified_afterstring date-time nullable

Only files updated after this timestamp.

modified_beforestring date-time nullable

Only files updated before this timestamp.

cursorstring nullable

Opaque cursor from a previous page's next_cursor. Omit for the first page.

limitinteger

Rows per page.

Response

Successful Response

next_cursorstring nullable

Opaque; null means the last page.

total_countinteger required

Exact, and filtered by the caller's access predicate.

Changes

No recorded changes to this operation across all 1 revision of this API.