List Files

Get a paginated list of files.

Headers

X-API-KEYstringRequired

Query parameters

pageintegerOptional>=1Defaults to 1
Page offset for pagination.
sizeintegerOptional>=0Defaults to 10
Page size for pagination. Number of files to fetch.
namestringOptional

Case-insensitive filter for file name.

pathstringOptional
Path of the directory to filter for. Returns files in this directory and all its subdirectories.
templatebooleanOptionalDefaults to false
Filter to include only template files.
typeenumOptional
List of file types to filter for.
environmentstringOptional

Case-sensitive filter for files with a deployment in the specified environment. Requires the environment name.

sort_byenumOptional
Field to sort files by
Allowed values:
orderenumOptional
Direction to sort by.
Allowed values:
include_raw_file_contentbooleanOptionalDefaults to false
Whether to include the raw file content in the response. Currently only supported for Agents and Prompts.

Response

Successful Response
recordslist of objects
pageinteger
sizeinteger
totalinteger

Errors