> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.basement.chat/pt-br/api-reference/api-do-gateway/files/read/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.basement.chat/_mcp/server. # Read a file POST https://mcp.basement.chat/v1/tools/read_file Content-Type: application/json Get a Basement file's metadata and a temporary download URL by ID. For text files up to 256 KB, also returns the text in content. Records an agent read. Reference: https://docs.basement.chat/pt-br/api-reference/api-do-gateway/files/read ## Authentication - `Authorization` header (bearer token, required) — A Basement key (bsmt_...), from Agents, Connect in the app. ## Request ### Body (application/json) This endpoint expects an object. - `fileId` (string, required) — The file ID from list_files, list_skills or search - `agentName` (string, optional) — Optional agent name for attribution ## Response ### 200 The tool's answer. - `id` (string, required) - `name` (string, required) - `kind` (string, required) - `mimeType` (string, required) - `sizeBytes` (integer, required) - `versionCount` (integer, required) - `downloadUrl` (string, required, nullable) — A temporary URL to download the file - `content` (string, required, nullable) — The file's text, for text files up to 256 KB - `folderId` (string, optional, nullable) - `folderName` (string, optional) ## Errors ### 400 Bad Request Error The arguments are not valid, or the tool refused them. - `error` (ErrorResponseError, required) ### 401 Unauthorized Error The API key is missing, wrong, revoked or expired. - `error` (ErrorResponseError, required) ### 403 Forbidden Error The key's access level does not allow this call. - `error` (ErrorResponseError, required) ### 429 Too Many Requests Error Too many calls in a minute. Wait and try again. - `error` (ErrorResponseError, required) ### 500 Internal Server Error Basement failed to complete the call. - `error` (ErrorResponseError, required) ## Types ### ErrorResponseError - `code` (string, required) — unauthorized, forbidden, invalid_request, not_found, rate_limited, service_error or internal_error - `message` (string, required) — What went wrong, in English ## Examples **Request** ```json { "fileId": "string" } ``` **Response** ```json { "id": "string", "name": "string", "kind": "string", "mimeType": "string", "sizeBytes": 1, "versionCount": 1, "downloadUrl": "string", "content": "string", "folderId": "string", "folderName": "string" } ``` **SDK Code** ```python import requests url = "https://mcp.basement.chat/v1/tools/read_file" payload = { "fileId": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://mcp.basement.chat/v1/tools/read_file'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"fileId":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://mcp.basement.chat/v1/tools/read_file" payload := strings.NewReader("{\n \"fileId\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://mcp.basement.chat/v1/tools/read_file") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"fileId\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://mcp.basement.chat/v1/tools/read_file") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"fileId\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://mcp.basement.chat/v1/tools/read_file', [ 'body' => '{ "fileId": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://mcp.basement.chat/v1/tools/read_file"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"fileId\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["fileId": "string"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://mcp.basement.chat/v1/tools/read_file")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```