files

List Files

Get a paginated list of files.

get/files

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/files
  • Auth: API key in header X-API-KEY

Query parameters

pageinteger

Page offset for pagination.

sizeinteger

Page size for pagination. Number of files to fetch.

namestring

Case-insensitive filter for file name.

pathstring

Path of the directory to filter for. Returns files in this directory and all its subdirectories.

templateboolean

Filter to include only template files.

type'prompt' | 'tool' | 'dataset' | 'evaluator' | 'flow' | 'agent'

Enum for File types.

List of file types to filter for.

environmentstring

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

sort_by'created_at' | 'updated_at' | 'name'

An enumeration.

Field to sort files by

order'asc' | 'desc'

An enumeration.

Direction to sort by.

include_raw_file_contentboolean

Whether to include the raw file content in the response. Currently only supported for Agents and Prompts.

Response

Successful Response

pageinteger required
sizeinteger required
totalinteger required

Changes

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