Browse files and folders by logical path prefix in a workspace

GET

/v1/storage/objects/by-path/browse

GET

/v1/storage/objects/by-path/browse

1 import requests
2 
3 url = "https://api.bctrl.ai/v1/storage/objects/by-path/browse"
4 
5 querystring = {"workspace":"marketing-assets","prefix":"campaigns/2024/spring","cursor":"YXJyYXljb25uZWN0aW9uOjEw","limit":"50"}
6 
7 payload = {}
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

200Retrieved

1 {
2   "files": [
3     {
4       "lastModified": "2024-06-10T15:22:30Z",
5       "path": "campaigns/2024/spring/banner_ad.png",
6       "size": 245678
7     }
8   ],
9   "folders": [
10     "campaigns/2024/spring/assets"
11   ],
12   "limit": 50,
13   "nextCursor": "YXJyYXljb25uZWN0aW9uOjUw",
14   "prefix": "campaigns/2024/spring",
15   "truncated": true
16 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Query parameters

workspacestringRequired

prefixstringOptional

cursorstringOptional

limitinteger or stringOptional

Response

Default Response

fileslist of objects

folderslist of strings

limitinteger<=9007199254740991

nextCursorstring or null

prefixstring

truncatedboolean