List Objects

GET

/api/v1/storage/objects

List storage objects with optional filters and pagination.

Supports filtering by:

correlation_id: Search metadata for matching correlation_id
stage: Search metadata for matching stage
route_id: Search metadata for matching route_id
prefix: Filter by key prefix (filesystem path)
delimiter: Character for hierarchical listing (returns common_prefixes for folders)

When delimiter is provided (typically ’/’), the response includes:

objects: Files at the current level
common_prefixes: Folder prefixes for navigation
execution_prefixes: Enriched execution info when include_execution_info=true

Args: storage: Storage provider (injected) correlation_id: Filter by correlation_id stage: Filter by stage name route_id: Filter by route_id prefix: Filter by key prefix delimiter: Delimiter for hierarchical listing (typically ’/’) include_metadata: Include full sidecar metadata in each object (default: true) include_execution_info: Enrich execution ID prefixes with execution metadata (default: false) limit: Maximum results per page (default: 100, max: 1000) offset: Number of records to skip for pagination (default: 0)

Returns: ListObjectsResponse with matching objects, common_prefixes, and execution_prefixes

Raises: HTTPException: 503 if storage not available

Parameters

Query Parameters

correlation_id

Any of:

string
null

string

Filter by correlation_id

stage

Any of:

string
null

string

Filter by stage name

route_id

Any of:

string
null

string

Filter by route_id

prefix

Any of:

string
null

string

Filter by key prefix

delimiter

Any of:

string
null

string

Delimiter for hierarchical listing (typically ’/’)

extension

Any of:

string
null

string

File extension filter (.md, .json; comma-separated)

include_metadata

Include Metadata

Include sidecar metadata in response

boolean

default: true

Include sidecar metadata in response

include_execution_info

Include Execution Info

Enrich execution ID prefixes with execution info

boolean

Enrich execution ID prefixes with execution info

limit

Limit

Maximum results per page

integer

default: 100 >= 1 <= 1000

Maximum results per page

offset

Offset

Number of records to skip

integer

Number of records to skip

Responses

200

Successful Response

ListObjectsResponse

Paginated response for listing objects.

object

objects

required

Objects

List of objects

Array<object>

StorageObjectSummary

Summary of a storage object for list responses.

object

key

required

Key

Full object key

string

size

required

Size

Content size in bytes

integer

content_type

required

Content Type

MIME type

string

modified_at

required

Modified At

Last modified timestamp

string format: date-time

metadata

Metadata

Object metadata

object

key

additional properties

string

sidecar

Any of:

SidecarMetadata
null

SidecarMetadata

Sidecar metadata from .meta.json files.

Contains pipeline lineage and processing metadata stored alongside content.

object

correlation_id

Any of:

string
null

string

parent_correlation_id

Any of:

string
null

string

route_id

Any of:

string
null

string

stage

Any of:

string
null

string

content_type

Any of:

string
null

string

content_length

Any of:

integer
null

integer

checksum

Any of:

string
null

string

created_at

Any of:

string
null

string

modified_at

Any of:

string
null

string

url

Any of:

string
null

string

title

Any of:

string
null

string

document_id

Any of:

string
null

string

original_object_key

Any of:

string
null

string

extra

Extra

Additional metadata fields

object

key

additional properties

string

common_prefixes

Common Prefixes

Common prefixes (folders) when delimiter is used

Array<string>

execution_prefixes

Execution Prefixes

Enriched execution info when include_execution_info=true

Array<object>

ExecutionPrefixInfo

Enriched information for execution ID prefixes.

When include_execution_info=true, common_prefixes that are execution IDs are enriched with execution metadata.

object

prefix

required

Prefix

The prefix path (execution ID)

string

execution_id

Any of:

string
null

string

config_id

Any of:

string
null

string

config_name

Any of:

string
null

string

status

Any of:

string
null

string

started_at

Any of:

string
null

string

completed_at

Any of:

string
null

string

total

required

Total

Total number of objects matching filters

integer

limit

required

Limit

Maximum entries per page

integer

offset

required

Offset

Offset from start

integer

has_more

required

Has More

Whether more objects exist

boolean

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object