Read a UTF-8 text preview by logical path from workspace

GET

/v1/storage/objects/by-path/read/:path

GET

/v1/storage/objects/by-path/read/:path

1 import requests
2 
3 url = "https://api.bctrl.ai/v1/storage/objects/by-path/read/projects%2Fproject-alpha%2Fdocs%2Freadme.md"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(url, json=payload, headers=headers)
12 
13 print(response.json())

200Retrieved

1 {
2   "content": "## Project Alpha\n\nWelcome to the Project Alpha documentation. This file provides an overview of the project goals, setup instructions, and usage guidelines.\n\n### Overview\nProject Alpha is designed to streamline data processing workflows using AI-driven automation.\n\n### Setup\n1. Clone the repository.\n2. Install dependencies using `npm install`.\n3. Run the application with `npm start`.\n\n### Usage\nRefer to the API documentation for detailed endpoint descriptions and examples."
3 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

pathstringRequired

Response

Read a UTF-8 text preview by logical path from workspace response