Skip to main content
POST
/
boxes
/
{boxId}
/
fs
/
exists
JavaScript
import GboxSDK 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: check if a file/directory exists
  const fileExistsResult = await box.fs.exists({
    path: "/tmp/example.txt",
  });

  console.log("File exists:", fileExistsResult.exists);

  // example: check if a file/directory does not exist
  const fileNotExistsResult = await box.fs.exists({
    path: "/tmp/non-existent.txt",
  });

  console.log("File not exists:", fileNotExistsResult.exists);
}

main();
{
  "exists": true,
  "type": "file"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

boxId
string
required

Box ID

Example:

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

Body

application/json

Request parameters for checking if a file/directory exists

path
string
required

Target path in the box. If the path does not start with '/', the file/directory will be checked relative to the working directory

Example:

"/home/user/documents/output.txt"

workingDir
string

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

Example:

"/home/user/documents"

Response

200 - application/json

Checks whether a file or directory exists inside a box. Use this endpoint for path validation.

  • Exists File/Directory Result
  • Not Exists File/Directory Result

Response after checking if a file/directory exists

exists
boolean
required

Exists

Example:

true

type
string
required

Type

Example:

"file"

I