Skip to main content
GET
List the indexed codebase's files
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/factories/listCodebaseFiles returns one page of the files in the deployment’s indexed codebase, in path order, each as a CodebaseFile: its path and how many chunks it holds. It takes only limit (1 to 100, default 100) and cursor. Every file is listed once, with its whole chunk count: follow meta.nextCursor while meta.hasMore is true. A page reads at most 500 index entries, so a file with more chunks than that answers pages with no files, and meta.hasMore: true, until its count is complete. A malformed limit or cursor is 400 bad_request. Deployment-root read. The indexed codebase has no home org unit, so your role grants must hold factories:read at the deployment root. Holding it only below the root, or at a partner organization’s root, is refused with 403 and requiredPermission: "factories:read". Search chunk text with Search the codebase.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:100

Items per page, 1 to 100 (default 100); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 100
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Indexed file page

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.