Filen Docs

https://docs.filen.io
Admin
Build your own apps and integrations on top of Filen with CLI, SDK, and API documentation.
Tokens:44,661
Snippets:508
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Filen CLI on Linux/macOS

Source: https://docs.filen.io/docs/cli-rs/readme

Use this command to install the Filen CLI on Linux and macOS systems. It fetches and executes an installation script.

```bash
curl -sL https://raw.githubusercontent.com/FilenCloudDienste/filen-rs/refs/heads/main/filen-cli/install.sh | bash  

```

--------------------------------

### Start a single-user WebDAV server

Source: https://docs.filen.io/docs/cli/webdav-and-s3-server

Invoke `filen webdav` to start a local WebDAV server mirroring your Filen Drive. You must specify unique login credentials using `--w-user` and `--w-password`.

```bash
$ filen webdav --w-user <...> --w-password <...> [options...]  
```

--------------------------------

### Install Filen SDK using NPM

Source: https://docs.filen.io/docs/sdk/getting-started

Use this command to install the latest version of the Filen SDK. Ensure you are using a Node.js compatible JavaScript runtime.

```bash
npm install @filen/sdk@latest
```

--------------------------------

### cURL Request Example

Source: https://docs.filen.io/docs/api/specs/get-shared-in-items

Example of how to make a POST request to the Get Shared In Items endpoint using cURL. The request includes necessary headers and content type.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/shared/in' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Example sync pairs JSON configuration

Source: https://docs.filen.io/docs/cli/syncing

An example of a JSON file defining sync pairs. Note that backslashes in paths must be escaped.

```json
[
	{
		"local": "/home/user/Pictures",
		"remote": "/Pictures",
		"syncMode": "cloudBackup"
	},
	{
		"local": "/home/user/Documents",
		"remote": "/Documents",
		"syncMode": "twoWay",
		"alias": "documents",
		"disableLocalTrash": true,
		"ignore": ["example.txt", "*.log"],
		"excludeDotFiles": true
	}
]

```

--------------------------------

### Install Filen CLI using curl

Source: https://docs.filen.io/docs/cli

Installs the Filen CLI on Linux and macOS systems by downloading and executing a script. This is the recommended method for non-Docker installations.

```bash
curl -sL https://filen.io/cli.sh | bash  

```

--------------------------------

### Start an S3 server

Source: https://docs.filen.io/docs/cli/webdav-and-s3-server

Invoke `filen s3` to start an S3 server mirroring your Filen Drive. You must specify S3 credentials using `--s3-access-key-id` and `--s3-secret-access-key`. When connecting, enable `s3ForcePathStyle` and set the region to `filen`.

```bash
$ filen s3 --s3-access-key-id <...> --s3-secret-access-key <...> [options...]  
```

--------------------------------

### Get User Public Key - Node.js

Source: https://docs.filen.io/docs/api/specs/get-user-public-key

Example of how to fetch a user's public key using Node.js. This snippet demonstrates making a POST request to the API endpoint.

```javascript
const fetch = require('node-fetch');

async function getUserPublicKey(email) {
  const response = await fetch('https://gateway.filen.io/v3/user/publicKey', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    },
    body: JSON.stringify({ email: email })
  });
  return await response.json();
}

getUserPublicKey('user@example.com').then(data => console.log(data));
```

--------------------------------

### POST /dir/tree Request Example

Source: https://docs.filen.io/docs/api/specs/get-flattened-directory-tree

Example of how to make a POST request to the /dir/tree endpoint using cURL. Ensure the Content-Type and Accept headers are set correctly for JSON communication.

```bash
curl -L -X POST 'https://gateway.filen.io/v3/dir/tree' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Start a WebDAV proxy server

Source: https://docs.filen.io/docs/cli/webdav-and-s3-server

Invoke `filen webdav-proxy` to start a WebDAV server that allows users to connect with their Filen account credentials. This is useful for hosting a proxy for multiple users. Digest auth is not available for proxy mode.

```bash
$ filen webdav-proxy [options...]  
```

--------------------------------

### Get Directory Public Link Size with cURL

Source: https://docs.filen.io/docs/api/specs/get-directory-public-link-size

Example of how to call the Get Directory Public Link Size endpoint using cURL. This includes setting the content type and accept headers.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/dir/size/link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Share Item cURL Example

Source: https://docs.filen.io/docs/api/specs/create-share-out

Use this cURL command to share an item. Ensure you set the Content-Type and Accept headers.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/item/share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### POST /dir/download Request Example

Source: https://docs.filen.io/docs/api/specs/get-directory-tree

This cURL command demonstrates how to make a POST request to the /dir/download endpoint to retrieve a directory tree. Ensure the Content-Type and Accept headers are set to application/json.

```bash
curl -L -X POST 'https://gateway.filen.io/v3/dir/download' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### File System Operations with SDK

Source: https://docs.filen.io/docs/sdk/file-system

Demonstrates various file system operations including creating directories, uploading, reading, writing, and downloading files, as well as getting file statistics. Ensure the 'filen' object is initialized and available in your scope.

```typescript
// Create a directory  
await filen.fs().mkdir({
	path: "/Pictures"
})

```

```typescript
// Upload a file  
await filen.fs().upload({
	path: "/Pictures",
	source: "/Local/path/to/a/file.jpg"
})

```

```typescript
// Read contents of the directory at path  
const content: string[] = await filen.fs().readdir({
	path: "/Pictures"
})

```

```typescript
// Stat a file  
const stats: FSStats = await filen.fs().stat({
	path: "/Pictures/file.jpg"
})

```

```typescript
// Download a file  
await filen.fs().download({
	path: "/Pictures/file.jpg",
	destination: "/Local/path/to/a/file.jpg"
})

```

```typescript
// Read a file  
const content: Buffer = await filen.fs().readFile({
	path: "/Pictures/file.jpg"
})

```

```typescript
// Write to a path  
await filen.fs().writeFile({
	path: "/text.txt",
	content: Buffer.from("foobar", "utf-8")
})

```

--------------------------------

### List All Conversations

Source: https://docs.filen.io/docs/sdk/chats

Use this to retrieve a list of all conversations. No specific setup is required beyond initializing the SDK.

```javascript
await filen.chats().conversations()
```

--------------------------------

### Set User Keypair cURL Request

Source: https://docs.filen.io/docs/api/specs/set-user-keypair

Example of how to set a user's keypair using cURL. Ensure the Content-Type and Accept headers are set correctly.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/user/keyPair/set' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Login Request using cURL

Source: https://docs.filen.io/docs/api/specs/login

Example of how to make a login request using cURL. This command sends a JSON payload to the login endpoint.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/login' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Get User Base Folder Request

Source: https://docs.filen.io/docs/api/specs/get-user-base-folder

This cURL command demonstrates how to make a request to the Get User Base Folder endpoint. Ensure you include the necessary Accept header for JSON responses.

```bash
curl -L 'https://gateway.filen.io/v3/user/baseFolder' \
-H 'Accept: application/json' \

```

--------------------------------

### Login with Filen SDK Credentials

Source: https://docs.filen.io/docs/sdk/authentication

Use this snippet to log in to the Filen SDK using your email, password, and optionally a two-factor authentication code. Ensure you have the SDK installed and imported. The `tmpPath` configuration is specific to Node.js environments.

```javascript
import { FilenSDK } from "@filen/sdk"
import os from "os"
import path from "path"

const filen = new FilenSDK({
	metadataCache: true, // Cache decrypted metadata in memory. Recommended.
	connectToSocket: true, // Recommended if you are using the virtual FS class. Keeps the internal item tree up to date with remote changes.
	tmpPath: path.join(os.tmpdir(), "filen-sdk") // Temporary local path used to store metadata and chunks. Only available in Node.JS.
})

await filen.login({
	email: "your@email.com",
	password: "supersecret123",
	twoFactorCode: "123456" // Can be omitted if you do not have 2FA enabled.
})
```

--------------------------------

### Get User Public Key - Python

Source: https://docs.filen.io/docs/api/specs/get-user-public-key

This Python script shows how to obtain a user's public key by sending a POST request to the Filen.io API. It includes setting the necessary headers and request body.

```python
import requests
import json

def get_user_public_key(email):
    url = "https://gateway.filen.io/v3/user/publicKey"
    headers = {
        "Content-Type": "application/json",
        "Accept": "application/json"
    }
    payload = {
        "email": email
    }
    response = requests.post(url, headers=headers, data=json.dumps(payload))
    return response.json()

print(get_user_public_key('user@example.com'))
```

--------------------------------

### Mount Filen Drive

Source: https://docs.filen.io/docs/cli/network-drive-mounting

Invoke `filen mount` to mount your Filen Drive. The default mount point is `X:` on Windows and `/tmp/filen` on UNIX-like systems. Ensure you have the necessary FUSE software installed for your OS.

```bash
$ filen mount [mount point]  

```

--------------------------------

### Get Directory Content

Source: https://docs.filen.io/docs/api/specs/get-directory-content

Use this cURL command to make a POST request to the /dir/content endpoint. Ensure the Content-Type and Accept headers are set to application/json.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/dir/content' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Get Shared Folder Directory Tree (cURL)

Source: https://docs.filen.io/docs/api/specs/get-directory-tree-of-shared-folder

Use this cURL command to send a POST request to the shared folder download endpoint. Ensure you include the `Content-Type` and `Accept` headers.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/dir/download/shared' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Change Directory Color cURL Example

Source: https://docs.filen.io/docs/api/specs/change-directory-color

Use this cURL command to change a directory's color. Replace placeholder values with your actual directory UUID and desired color.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/dir/color' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "uuid": "string",
  "color": "string"
}'
```

--------------------------------

### Get File Info Request

Source: https://docs.filen.io/docs/api/specs/get-file-info

This snippet shows how to make a POST request to the /file endpoint to retrieve file information. Ensure the Content-Type and Accept headers are set to application/json.

```cURL
curl -L -X POST 'https://gateway.filen.io/v3/file' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Create Directory

Source: https://docs.filen.io/docs/cli/access-filen-drive

Creates a new directory at the specified path.

```bash
mkdir <path to directory>
```

--------------------------------

### Get User Keypair

Source: https://docs.filen.io/docs/api/specs/get-encrypted-user-keypair

This snippet shows how to retrieve the encrypted user keypair using a GET request.

```APIDOC
## GET /user/keyPair/info

### Description
Retrieve encrypted user keypair.

### Method
GET

### Endpoint
https://gateway.filen.io/v3/user/keyPair/info

### Response
#### Success Response (200)
- **status** (string) - OPTIONAL
- **message** (string) - OPTIONAL
- **code** (string) - OPTIONAL
- **data** (object) - OPTIONAL
  - **publicKey** (string) - OPTIONAL
  - **privateKey** (string) - OPTIONAL

### Request Example
```curl
curl -L 'https://gateway.filen.io/v3/user/keyPair/info' \
-H 'Accept: application/json'
```
```

--------------------------------

### Remove Directory Public Link cURL Example

Source: https://docs.filen.io/docs/api/specs/remove-directory-public-link

Example of how to remove a public link from a directory using cURL. Ensure to include the 'Content-Type' and 'Accept' headers.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/dir/link/remove' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Create Directory

Source: https://docs.filen.io/docs/sdk/cloud

Use this to create a new directory. You need to specify the parent directory's UUID, the new directory name, and optionally if renaming should occur if a directory with the same name already exists.

```javascript
// Create a directory  
await filen.cloud().createDirectory({
	uuid: "uuidv4",
	name: "directoryName",
	parent: "uuidv4",
	renameIfExists: typeof boolean
})
```

--------------------------------

### Get Directory Size cURL Request

Source: https://docs.filen.io/docs/api/specs/get-directory-size

Use this cURL command to send a POST request to the /dir/size endpoint to get the directory size. Ensure the Content-Type and Accept headers are set to application/json.

```bash
curl -L -X POST 'https://gateway.filen.io/v3/dir/size' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Create Directory

Source: https://docs.filen.io/docs/sdk/file-system

Creates a new directory at the specified path.

```APIDOC
## Create Directory

### Description
Creates a new directory at the specified path.

### Method
`mkdir`

### Parameters
#### Path Parameters
- **path** (string) - Required - The path where the directory should be created.

### Request Example
```javascript
await filen.fs().mkdir({
	path: "/Pictures"
})
```
```

--------------------------------

### Create Directory

Source: https://docs.filen.io/docs/api/specs/create-directory

Creates a new directory with the specified name and parent.

```APIDOC
## POST /dir/create

### Description
Creates a new directory with the specified name and parent.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/create

### Parameters
#### Request Body
- **uuid** (string) - REQUIRED
- **name** (string) - REQUIRED
- **nameHashed** (string) - REQUIRED
- **parent** (string) - REQUIRED

### Response
#### Success Response (200)
- **status** (string) - OPTIONAL
- **message** (string) - OPTIONAL
- **code** (string) - OPTIONAL
- **data** (object) - OPTIONAL
  - **uuid** (string) - OPTIONAL

### Request Example
```json
{
  "uuid": "string",
  "name": "string",
  "nameHashed": "string",
  "parent": "string"
}
```

### Response Example
```json
{
  "status": "string",
  "message": "string",
  "code": "string",
  "data": {
    "uuid": "string"
  }
}
```
```

--------------------------------

### Download File to Local

Source: https://docs.filen.io/docs/sdk/cloud

Use this to download a file from the cloud to your local system. Requires the file's UUID, bucket, region, and destination path. Optional parameters include chunk size, version, key, and size.

```javascript
// Download a file  
await filen.cloud().downloadFileToLocal({
	uuid: "uuidv4",
	bucket: "filen-1",
	region: "de-1",
	chunks: 1,
	version: typeof FileEncryptionVersion,
	key: "TrHQda5sCsXCH8NZbKx0lxfYHpt5JClh",
	size: 123,
	to: "/path/to/local/file.txt"
})
```

--------------------------------

### Get File Stats

Source: https://docs.filen.io/docs/sdk/file-system

Retrieves statistics about a file at the specified path.

```APIDOC
## Get File Stats

### Description
Retrieves statistics about a file at the specified path.

### Method
`stat`

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to the file.

### Response
#### Success Response (200)
- **stats** (FSStats) - An object containing file statistics.

### Response Example
```javascript
const stats: FSStats = await filen.fs().stat({
	path: "/Pictures/file.jpg"
})
```
```

--------------------------------

### Get API Health

Source: https://docs.filen.io/docs/api/specs/get-api-health

This endpoint allows you to check the current health status of the API.

```APIDOC
## GET /health

### Description
Retrieves the health status of the API.

### Method
GET

### Endpoint
/health

### Response
#### Success Response (200)
- **health** (string) - OPTIONAL - Indicates the health status of the API.
```

--------------------------------

### Sync pairs from custom registry file

Source: https://docs.filen.io/docs/cli/syncing

Specifies a custom JSON file to read sync pair configurations from. The file format is identical to the central registry.

```bash
filen sync <file>
```

--------------------------------

### Get Auth Info

Source: https://docs.filen.io/docs/api/specs/get-auth-info

Retrieves user-specific authentication information based on the provided email.

```APIDOC
## Get Auth Info

### Description
Returns user-specific authentication info.

### Method
POST

### Endpoint
/auth/info

### Parameters
#### Request Body
- **email** (string) - Required - The user's email

### Response
#### Success Response (200)
- **status** (boolean) - Optional - Indicates the success of the operation.
- **message** (string) - Optional - A message providing details about the response.
- **code** (string) - Optional - A status code associated with the response.
```

--------------------------------

### Get User Base Folder

Source: https://docs.filen.io/docs/api/specs/get-user-base-folder

This endpoint returns the UUID of the user's root directory.

```APIDOC
## GET /user/baseFolder

### Description
Returns the UUID of the user's root directory.

### Method
GET

### Endpoint
/user/baseFolder

### Response
#### Success Response (200)
- **status** (boolean) - OPTIONAL
- **message** (string) - OPTIONAL
- **code** (string) - OPTIONAL
- **data** (object) - OPTIONAL
  - **uuid** (string) - OPTIONAL - the user's root directory's UUID

### Request Example
```curl
curl -L 'https://gateway.filen.io/v3/user/baseFolder' \
-H 'Accept: application/json'
```
```

--------------------------------

### Download File or Directory

Source: https://docs.filen.io/docs/cli/access-filen-drive

Downloads a file or directory from your Filen cloud drive to a specified local destination.

```bash
download <cloud path> <local destination>
```

--------------------------------

### Get User Root Directory UUID

Source: https://docs.filen.io/docs/api/guides/files

Retrieves the UUID for the user's root directory.

```APIDOC
## GET /v3/user/baseFolder

### Description
Retrieves the UUID of the user's root directory.

### Method
GET

### Endpoint
/v3/user/baseFolder
```

--------------------------------

### Get File Info

Source: https://docs.filen.io/docs/api/specs/get-file-info

Retrieve file information by providing the file's UUID in the request body.

```APIDOC
## POST /file

### Description
Retrieve file information by providing the file's UUID in the request body.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/file

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier of the file.

### Response
#### Success Response (200 OK)
- **status** (string) - Optional - The status of the operation.
- **message** (string) - Optional - A message describing the result.
- **code** (string) - Optional - An error code if applicable.
- **data** (object) - Optional - Contains file details.
  - **uuid** (string) - Optional
  - **region** (string) - Optional
  - **bucket** (string) - Optional
  - **nameEncrypted** (string) - Optional
  - **nameHashed** (string) - Optional
  - **sizeEncrypted** (string) - Optional
  - **mimeEncrypted** (string) - Optional
  - **metadata** (string) - Optional
  - **size** (string) - Optional
  - **parent** (string) - Optional
  - **versioned** (string) - Optional
  - **trash** (string) - Optional
  - **version** (string) - Optional

### Request Example
```json
{
  "uuid": "your_file_uuid"
}
```

### Response Example
```json
{
  "status": "OK",
  "message": "File info retrieved successfully.",
  "code": "200",
  "data": {
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "region": "us-east-1",
    "bucket": "my-bucket",
    "nameEncrypted": "encrypted_name.txt",
    "nameHashed": "hashed_name.txt",
    "sizeEncrypted": "1024",
    "mimeEncrypted": "text/plain",
    "metadata": "some_metadata",
    "size": "1024",
    "parent": "/path/to/parent",
    "versioned": "true",
    "trash": "false",
    "version": "1"
  }
}
```
```

--------------------------------

### Sync literal path pair (two-way)

Source: https://docs.filen.io/docs/cli/syncing

Synchronizes a local path with a cloud path in a two-way sync mode directly from the command line.

```bash
filen sync /local/path:twoWay:/cloud/path
```

--------------------------------

### Get Flattened Directory Tree

Source: https://docs.filen.io/docs/api/specs/get-flattened-directory-tree

Retrieves a complete, flattened directory tree. This endpoint is intended for syncing operations.

```APIDOC
## POST /dir/tree

### Description
Get a complete directory tree (meant for syncing, flattened).

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/tree

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier for the user or session.
- **deviceId** (string) - Required - The identifier for the device making the request.
- **skipCache** (string) - Required - A flag to indicate whether to skip the cache.

### Request Example
```json
{
  "uuid": "string",
  "deviceId": "string",
  "skipCache": "string"
}
```

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the response.
- **message** (string) - Optional - A message providing details about the response.
- **code** (string) - Optional - An error code, if applicable.
- **data** (object) - Optional - Contains the directory tree data.
  - **folders** (string) - Optional - Information about folders.
  - **files** (string) - Optional - Information about files.

#### Response Example
```json
{
  "status": "string",
  "message": "string",
  "code": "string",
  "data": {
    "folders": "string",
    "files": "string"
  }
}
```
```

--------------------------------

### Create New Directory

Source: https://docs.filen.io/docs/api/guides/files

Creates a new directory within the user's file system.

```APIDOC
## POST /v3/dir/create

### Description
Creates a new directory. The directory name is client-side encrypted.

### Method
POST

### Endpoint
/v3/dir/create
```

--------------------------------

### Open File Locally

Source: https://docs.filen.io/docs/cli/access-filen-drive

Opens a file locally using the system's default application associated with its file type.

```bash
open <file>
```

--------------------------------

### Get User Public Key

Source: https://docs.filen.io/docs/api/specs/get-user-public-key

This endpoint retrieves the public key associated with a given user's email.

```APIDOC
## POST /user/publicKey

### Description
Retrieve a user's public key by providing their email in the request body.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/user/publicKey

### Parameters
#### Request Body
- **email** (string) - Required - The email address of the user whose public key is to be retrieved.

### Response
#### Success Response (200 OK)
- **status** (string) - Optional - The status of the operation.
- **message** (string) - Optional - A message describing the result of the operation.
- **code** (string) - Optional - An error code if the operation failed.
- **data** (object) - Optional - Contains the public key if the operation was successful.
  - **publicKey** (string) - Optional - The user's public key.

### Request Example
```json
{
  "email": "user@example.com"
}
```

### Response Example
```json
{
  "status": "success",
  "message": "Public key retrieved successfully",
  "data": {
    "publicKey": "your_public_key_here"
  }
}
```
```

--------------------------------

### Get Shared Out Items

Source: https://docs.filen.io/docs/api/specs/get-shared-out-items

This endpoint retrieves items that have been shared out. It requires a UUID and a receiver ID in the request body.

```APIDOC
## POST /shared/out

### Description
Retrieves items that have been shared out. Requires a JSON request body with 'uuid' and 'receiverId'.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/shared/out

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier for the item.
- **receiverId** (string) - Required - The identifier of the receiver.

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the operation.
- **message** (string) - Optional - A message describing the result.
- **code** (string) - Optional - An error code if applicable.
- **data** (object) - Optional - Contains shared out item details.
  - **uploads** (string) - Optional - Information about uploads.
  - **folders** (string) - Optional - Information about folders.
```

--------------------------------

### Display File Content

Source: https://docs.filen.io/docs/cli/access-filen-drive

Prints the content of a text file to the standard output.

```bash
cat <path to file>
```

--------------------------------

### Shorthand for two-way sync pairs

Source: https://docs.filen.io/docs/cli/syncing

A concise way to specify two-way synchronization between local and cloud directories.

```bash
filen sync /local:/cloud
```

--------------------------------

### Get Directory Public Link Status

Source: https://docs.filen.io/docs/api/specs/get-directory-public-link-status

This endpoint retrieves the status of a public link for a given directory UUID.

```APIDOC
## POST /dir/link/status

### Description
Retrieve status of a folder public link.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/link/status

### Parameters
#### Request Body
- **uuid** (string) - Required - The UUID of the directory.

### Request Example
```json
{
  "uuid": "your_directory_uuid"
}
```

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the operation.
- **message** (string) - Optional - A message describing the result.
- **code** (string) - Optional - An error code if applicable.
- **data** (object) - Optional - Contains details about the public link.
  - **exists** (string) - Optional - Indicates if the link exists.
  - **uuid** (string) - Optional - The UUID of the link.
  - **key** (string) - Optional - The public link key.
  - **expiration** (string) - Optional - The expiration timestamp of the link.
  - **expirationText** (string) - Optional - A human-readable expiration date.
  - **downloadBtn** (string) - Optional - Indicates if the download button is enabled.
  - **password** (string) - Optional - Indicates if the link is password protected.
```

--------------------------------

### Display File or Directory Information

Source: https://docs.filen.io/docs/cli/access-filen-drive

Shows detailed information about a file or directory.

```bash
stat <path>
```

--------------------------------

### List Directory Contents

Source: https://docs.filen.io/docs/cli/access-filen-drive

Lists items within a specified directory. Use the -l flag for a more detailed output.

```bash
ls <path to directory>
```

```bash
ls -l <path to directory>
```

--------------------------------

### Get Directory Tree

Source: https://docs.filen.io/docs/api/specs/get-directory-tree

Retrieves the complete folder tree (flattened) by sending a POST request with a JSON body containing the 'uuid'.

```APIDOC
## POST /dir/download

### Description
Retrieves the complete folder tree (flattened).

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/download

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier for the directory.

### Request Example
```json
{
  "uuid": "string"
}
```

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the response.
- **message** (string) - Optional - A message describing the response.
- **code** (string) - Optional - A code indicating the response type.
- **data** (object) - Optional - Contains the directory tree data.
  - **files** (string) - Optional - Information about files.
  - **folders** (string) - Optional - Information about folders.
```

--------------------------------

### Get Shared In Items

Source: https://docs.filen.io/docs/api/specs/get-shared-in-items

Retrieves a list of items that have been shared with the authenticated user. Requires a JSON request body containing the 'uuid' of the user.

```APIDOC
## POST /shared/in

### Description
Retrieves a list of items that have been shared with the authenticated user.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/shared/in

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier of the user.

### Request Example
```json
{
  "uuid": "string"
}
```

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the response.
- **message** (string) - Optional - A message describing the response.
- **code** (string) - Optional - An error code, if applicable.
- **data** (object) - Optional - Contains the shared items.
  - **uploads** (string) - Optional - Information about uploads.
  - **folders** (string) - Optional - Information about folders.

#### Response Example
```json
{
  "status": "string",
  "message": "string",
  "code": "string",
  "data": {
    "uploads": "string",
    "folders": "string"
  }
}
```
```

--------------------------------

### Get File Public Link Info Endpoint

Source: https://docs.filen.io/docs/api/specs/get-file-public-link-info

This is the API endpoint for retrieving file public link information. It requires a POST request.

```http
POST /file/link/info
```

--------------------------------

### View Directory in Web Drive

Source: https://docs.filen.io/docs/cli/access-filen-drive

Opens a specified directory within the Filen Web Drive interface in your browser.

```bash
view <path>
```

--------------------------------

### Get Shared In Items Request

Source: https://docs.filen.io/docs/api/specs/get-shared-in-items

Use this endpoint to retrieve shared items. Ensure the request body includes the required 'uuid' field.

```http
POST /shared/in
```

--------------------------------

### Manage Contacts and Requests

Source: https://docs.filen.io/docs/sdk/contacts

Use these methods to list contacts, view and manage contact requests, and send new requests. Ensure you have the necessary permissions and valid identifiers.

```javascript
// List all contacts  
await filen.contacts().all()

```

```javascript
// List all incoming contact requests  
await filen.contacts().incomingRequests()

```

```javascript
// List all outgoing contact requests  
await filen.contacts().outgoingRequests()

```

```javascript
// Send a contact request  
await filen.contacts().sendRequest({
	email: "filenuser@example.com"
})

```

```javascript
// Accept a contact request  
await filen.contacts().acceptRequest({
	uuid: "uuidv4"
})

```

--------------------------------

### Upload File

Source: https://docs.filen.io/docs/cli/access-filen-drive

Uploads a local file to a specified path in your Filen cloud drive.

```bash
upload <local file> <cloud path>
```

--------------------------------

### Get Directory Info

Source: https://docs.filen.io/docs/api/specs/get-directory-info

Retrieves information about a directory using its UUID. This is a POST request that requires a JSON body containing the directory's UUID.

```APIDOC
## POST /dir

### Description
Returns information about a directory.

### Method
POST

### Endpoint
/dir

### Parameters
#### Request Body
- **uuid** (string) - Required - The desired directory's UUID

### Response
#### Success Response (200)
- **status** (boolean) - Optional - Indicates the success of the operation.
- **message** (string) - Optional - A message describing the result of the operation.
- **code** (string) - Optional - An internal code related to the operation's outcome.
- **uuid** (string) - Optional - The directory's UUID.
- **nameEncrypted** (string) - Optional - The directory's name (metadata-encrypted).
- **nameHashed** (string) - Optional - The hex-encoded SHA-512 hash of the directory's name.
- **parent** (string) - Optional - The parent directory's UUID.
- **trash** (boolean) - Optional - Indicates whether this directory is in the trash.
- **favorited** (boolean) - Optional - Indicates whether this directory is favorited.
- **color** (string) - Optional - The directory's assigned color (as hex code `#000000` or valid CSS value), or `null` if none is set.

### Request Example
```json
{
  "uuid": "your-directory-uuid"
}
```

### Response Example
```json
{
  "status": true,
  "message": "Directory info retrieved successfully.",
  "code": "SUCCESS",
  "uuid": "directory-uuid-123",
  "nameEncrypted": "EncryptedDirName",
  "nameHashed": "abcdef123456...",
  "parent": "parent-directory-uuid",
  "trash": false,
  "favorited": true,
  "color": "#FF0000"
}
```
```

--------------------------------

### List Trash Bin Items

Source: https://docs.filen.io/docs/sdk/cloud

Use this to list all items currently in the trash bin. No parameters are required.

```javascript
// List items inside the trash bin  
await filen.cloud().listTrash()
```

--------------------------------

### Export Notes

Source: https://docs.filen.io/docs/cli/access-filen-drive

Exports all your Filen Notes to a specified local path. Subdirectories will be created if the target path doesn't exist or is not empty. Richtext notes are saved as HTML, and checklist notes as Markdown.

```bash
filen export-notes <path>
```

--------------------------------

### Get Directory Public Link Size

Source: https://docs.filen.io/docs/api/specs/get-directory-public-link-size

Retrieves the size of a directory accessible via a public link. Requires a JSON body containing `uuid` and `linkUUID`.

```APIDOC
## POST /dir/size/link

### Description
Retrieve the size of a directory's public link.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/size/link

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier for the directory.
- **linkUUID** (string) - Required - The unique identifier for the public link.

### Request Example
```json
{
  "uuid": "string",
  "linkUUID": "string"
}
```

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the response.
- **message** (string) - Optional - A message describing the response.
- **code** (string) - Optional - An error code if applicable.
- **data** (object) - Optional - Contains the size information.
  - **size** (string) - Optional - The size of the directory.

#### Response Example
```json
{
  "status": "string",
  "message": "string",
  "code": "string",
  "data": {
    "size": "string"
  }
}
```
```

--------------------------------

### Get Directory Public Link Info

Source: https://docs.filen.io/docs/api/specs/get-directory-public-link-info

Use this endpoint to fetch the public link details of a directory. It requires the directory's UUID in the request body.

```APIDOC
## POST /dir/link/info

### Description
Get public link info of a folder.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/link/info

### Parameters
#### Request Body
- **uuid** (string) - Required - The UUID of the directory.

### Request Example
```json
{
  "uuid": "string"
}
```

### Response
#### Success Response (200)
- **status** (string) - Optional
- **message** (string) - Optional
- **code** (string) - Optional
- **data** (object) - Optional
  - **parent** (string) - Optional
  - **metadata** (string) - Optional
  - **hasPassword** (string) - Optional
  - **salt** (string) - Optional
  - **timestamp** (string) - Optional

#### Response Example
```json
{
  "status": "string",
  "message": "string",
  "code": "string",
  "data": {
    "parent": "string",
    "metadata": "string",
    "hasPassword": "string",
    "salt": "string",
    "timestamp": "string"
  }
}
```
```

--------------------------------

### Create a note

Source: https://docs.filen.io/docs/sdk/notes

Creates a new note with the specified UUID and title.

```APIDOC
## Create a note

### Description
Creates a new note with the specified UUID and title.

### Method
`notes().create(options)`

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier for the note.
- **title** (string) - Required - The title of the note.

### Request Example
```javascript
await filen.notes().create({
	uuid: "uuidv4",
	title: "Example note"
})
```

### Response
(Details not provided in source)
```

--------------------------------

### Rename File cURL Example

Source: https://docs.filen.io/docs/api/specs/rename-file

Use this cURL command to rename a file via the Filen.io gateway. Ensure the Content-Type and Accept headers are set to application/json.

```curl
curl -L -X POST 'https://gateway.filen.io/v3/file/rename' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Download File to Local

Source: https://docs.filen.io/docs/sdk/cloud

Downloads a file from cloud storage to a local path.

```APIDOC
## downloadFileToLocal

### Description
Downloads a file to a local path.

### Method
`downloadFileToLocal`

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The UUID of the file to download.
- **to** (string) - Required - The local path where the file should be saved.
- **bucket** (string) - Required - The bucket name where the file is stored.
- **region** (string) - Required - The region of the bucket.
- **key** (string) - Required - The encryption key for the file.
- **size** (number) - Required - The size of the file in bytes.
- **chunks** (number) - Optional - The number of chunks to download the file in.
- **version** (typeof FileEncryptionVersion) - Optional - The encryption version of the file.

### Request Example
```javascript
await filen.cloud().downloadFileToLocal({
	uuid: "uuidv4",
	bucket: "filen-1",
	region: "de-1",
	chunks: 1,
	version: typeof FileEncryptionVersion,
	key: "TrHQda5sCsXCH8NZbKx0lxfYHpt5JClh",
	size: 123,
	to: "/path/to/local/file.txt"
})
```
```

--------------------------------

### Get File Public Link Info

Source: https://docs.filen.io/docs/api/specs/get-file-public-link-info

This endpoint retrieves the public link information for a given file. It requires the file's UUID and password in the request body.

```APIDOC
## POST /file/link/info

### Description
Get public link info of a file.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/file/link/info

### Parameters
#### Request Body
- **uuid** (string) - Required - The unique identifier of the file.
- **password** (string) - Required - The password for the file, if applicable.

### Response
#### Success Response (200)
- **status** (string) - Optional - The status of the operation.
- **message** (string) - Optional - A message describing the result.
- **code** (string) - Optional - An internal code for the response.
- **data** (object) - Optional - Contains the file link information.
  - **bucket** (string) - Optional - The bucket where the file is stored.
  - **uuid** (string) - Optional - The unique identifier of the file.
  - **region** (string) - Optional - The region of the file storage.
  - **name** (string) - Optional - The name of the file.
  - **size** (string) - Optional - The size of the file.
  - **mime** (string) - Optional - The MIME type of the file.
  - **chunks** (string) - Optional - Information about file chunks.
  - **password** (string) - Optional - The password for the file, if set.
  - **downloadBtn** (string) - Optional - A string related to the download button.
  - **timestamp** (string) - Optional - The timestamp of the file.
  - **version** (string) - Optional - The version of the file.
```

--------------------------------

### Invoke filen sync command

Source: https://docs.filen.io/docs/cli/syncing

Use this command to initiate synchronization between specified locations and your Filen Drive. You can specify sync pairs directly or read them from a JSON file.

```bash
$ filen sync [sync pairs...] [--continuous]  
```

--------------------------------

### Get Shared Out Items cURL Request

Source: https://docs.filen.io/docs/api/specs/get-shared-out-items

Use this cURL command to send a POST request to the shared out endpoint. Ensure the Content-Type and Accept headers are correctly set.

```bash
curl -L -X POST 'https://gateway.filen.io/v3/shared/out' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Get Directory Content

Source: https://docs.filen.io/docs/api/specs/get-directory-content

Retrieves information about files and directories within a specified directory. The request requires a directory UUID and optionally accepts a boolean to filter for folders only.

```APIDOC
## POST /dir/content

### Description
Returns information about the files and directories inside a directory.

### Method
POST

### Endpoint
https://gateway.filen.io/v3/dir/content

### Parameters
#### Request Body
- **uuid** (string) - Required - The directory's UUID, or "favorites", "recents", "links", "trash" for special directories.
- **foldersOnly** (boolean) - Optional - Whether only directories should be returned (defaults to `false`).

### Response
#### Success Response (200)
- **status** (boolean) - Optional - Indicates the success of the operation.
- **message** (string) - Optional - A message describing the result of the operation.
- **code** (string) - Optional - An error code if the operation failed.
- **data** (object) - Optional - Contains the directory content.
  - **uploads** (object[]) - Optional - An array of file objects within this directory.
    - **uuid** (string) - Optional - The file's UUID.
    - **metadata** (string) - Optional - The file's metadata (encrypted).
    - **rm** (string) - Optional - TODO.
    - **timestamp** (integer) - Optional - TODO.
    - **chunks** (integer) - Optional - The number of chunks this file is split into.
    - **size** (integer) - Optional - The file's size in bytes.
    - **bucket** (string) - Optional - The storage bucket this file is stored in.
    - **region** (string) - Optional - The storage region this file is stored in.
    - **parent** (string) - Optional - The parent directory's UUID.
    - **version** (integer) - Optional - The file encryption version.
    - **favorited** (integer) - Optional - Whether this file is favorited (1 or 0).
  - **folders** (object[]) - Optional - An array of directory objects within this directory.
    - **uuid** (string) - Optional - The directory's UUID.
    - **name** (string) - Optional - The directory's name.
    - **parent** (string) - Optional - The parent directory's UUID.
    - **color** (string) - Optional - The directory's color.
    - **timestamp** (integer) - Optional - TODO.
    - **is_sync** (integer) - Optional - TODO.
    - **is_default** (integer) - Optional - TODO.

### Request Example
```json
{
  "uuid": "your-directory-uuid",
  "foldersOnly": true
}
```

### Response Example
```json
{
  "status": true,
  "message": "Directory content retrieved successfully.",
  "data": {
    "uploads": [
      {
        "uuid": "file-uuid-1",
        "metadata": "encrypted-metadata-string",
        "chunks": 5,
        "size": 1024000,
        "bucket": "your-bucket",
        "region": "your-region",
        "parent": "your-directory-uuid",
        "version": 1,
        "favorited": 0
      }
    ],
    "folders": [
      {
        "uuid": "subdir-uuid-1",
        "name": "Subdirectory 1",
        "parent": "your-directory-uuid",
        "color": "#ffffff",
        "is_sync": 0,
        "is_default": 0
      }
    ]
  }
}
```
```

--------------------------------

### List Directory Items

Source: https://docs.filen.io/docs/sdk/cloud

Use this to list items within a specified directory. Requires a directory UUID.

```javascript
// List items inside a directory  
await filen.cloud().listDirectory({
	uuid: "uuidv4"
})
```

--------------------------------

### Sync with other sync modes and abbreviations

Source: https://docs.filen.io/docs/cli/syncing

Specifies synchronization pairs with different sync modes, using abbreviations for brevity. Multiple pairs can be defined in a single command.

```bash
filen sync /local1:localToCloud:/cloud1 /local2:ltc:/cloud2
```

--------------------------------

### Get User Keypair Info (cURL)

Source: https://docs.filen.io/docs/api/specs/get-encrypted-user-keypair

Use this cURL command to retrieve the encrypted user keypair information from the gateway. Ensure the Accept header is set to application/json.

```curl
curl -L 'https://gateway.filen.io/v3/user/keyPair/info' \
-H 'Accept: application/json'
```

--------------------------------

### Upload Local File

Source: https://docs.filen.io/docs/sdk/cloud

Use this to upload a file from your local system to the cloud. Specify the source path, the parent directory's UUID, and the desired file name.

```javascript
// Upload a file  
await filen.cloud().uploadLocalFile({
	source: "/path/to/local/file.txt",
	parent: "uuidv4",
	name: "file.txt"
})
```
Tokens:
Raw