list_storage_files

imerit_ango.sdk.SDK.

list_storage_files(storage_id, bucket_name, path, get_signed_urls, retry_on_slow_down)

Recursively list all files stored in the specified storage, bucket or Azure container, and folder path.

Parameters

• storage_id: string

  • The unique identifier for the storage. You can retrieve the storage ID using get_storages function.

• bucket_name: string

  • The name of the storage bucket, or Azure container, to list files from.

  • Example: "ango-datasets"

• path: string, default ""

  • The directory path within the bucket or container to list files from. If empty, files are listed from the root.

  • Example: "project-1/images/batch-1/"

• get_signed_urls: bool, default True

  • Whether to generate signed URLs for the listed files. When enabled, each file entry includes a temporary URL for secure access.

• retry_on_slow_down: bool, default True

  • Whether to automatically retry the request if the storage service responds with a slow-down or rate-limiting error.

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

Example

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')

ango_sdk = SDK(api_key)

storage_id = "$STORAGE_ID"
sdk_response = ango_sdk.list_storage_files(
    storage_id=storage_id,
    bucket_name="ango-dataset",
    path="project-1/images/batch-1/",
    get_signed_urls=True,
    retry_on_slow_down=True
)

curl

curl -X GET "https://imeritapi.ango.ai/v2/storages/\$STORAGE_ID/files \
  ?bucketName=ango-dataset \
  &path=project-1/images/batch-1/ \
  &getSignedUrls=true \
  &retryOnSlowDown=true" \
  -H "Content-Type: application/json" \
  -H "apikey: YOUR_API_KEY"

See also

get_storages