Skip to main content
GET
/
boxes
/
{boxId}
/
fs
/
read
JavaScript
import GboxSDK, { isFileOperator } from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.create({ type: "linux" });
  // prepare: write a file
  await box.fs.write({
    path: "/tmp/example.txt",
    content: "Hello, world!",
  });

  // example: read a file/directory
  const file = await box.fs.get({
    path: "/tmp/example.txt",
  });

  if (isFileOperator(file)) {
    const { content } = await file.read();
    console.info(`πŸ“„ ${file.data.name} (${file.data.size}) - ${file.data.path}`);
    console.info(`content: ${content}`);
  } else {
    console.info(`πŸ“ ${file.data.name} - ${file.data.path} is a directory`);
  }
}

main();
{
  "content": "{\n  \"name\": \"My Project\",\n  \"version\": \"1.0.0\"\n}"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter your API Key in the format: Bearer . Get it from https://gbox.ai

Path Parameters

​
boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

Query Parameters

​
workingDir
string

Working directory. If not provided, the file will be read from the box.config.workingDir directory.

Example:

"/home/user/documents"

​
path
string
required

Target path in the box. If the path does not start with '/', the file will be read from the working directory.

Example:

"/home/user/documents/config.json"

Response

Read file

Response containing file content

​
content
string
required

Content of the file

Example:

"{\n \"name\": \"My Project\",\n \"version\": \"1.0.0\"\n}"