Skip to content

Browse Storage

GET
/api/v1/storage/browse

Browse storage hierarchy.

Navigate storage like a filesystem for Admin UI.

Args: storage: Storage provider (injected) path: Directory path to browse (empty for root)

Returns: BrowseResponse with directories and files

Raises: HTTPException: 503 if storage not available

path
Path

Directory path to browse

string
""

Directory path to browse

Successful Response

BrowseResponse

Response for browsing storage hierarchy.

object
path
required
Path

Current path

string
directories
required
Directories

Subdirectories

Array<string>
files
required
Files

Files in this directory

Array<string>
parent
Any of:
string
total_directories
required
Total Directories

Count of directories

integer
total_files
required
Total Files

Count of files

integer

Resource not found

ErrorResponse

Standard error response matching FastAPI HTTPException format.

This model is used in OpenAPI response declarations for 4xx/5xx errors. The detail field matches FastAPI’s HTTPException structure.

object
detail
required
Detail

Error message (matches FastAPI HTTPException)

string
error_code
Any of:
string
correlation_id
Any of:
string
timestamp
Timestamp

Error timestamp

string format: date-time

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