FlyFile API

https://flyfile.app/api-docs
Admin
API documentation for FlyFile, a file hosting and storage service with file management, folder...
Tokens:13,901
Snippets:143
Trust Score:5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install FlyFile-patched rclone

Source: https://flyfile.app/api-docs

Download and install the FlyFile-patched rclone binary. Ensure the binary is executable and moved to a directory in your system's PATH.

```bash
# Download the latest release for your OS, e.g.:
curl -L https://github.com/FlyFile-Storage/rclone/releases/latest/download/rclone-linux-amd64 -o rclone
chmod +x rclone && sudo mv rclone /usr/local/bin/
```

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

### Get Account Info (cURL)

Source: https://flyfile.app/api-docs

Example cURL command to retrieve account information from the Flyfile API.

```bash
curl -X GET "https://api.flyfile.app/api/v1/account" \
  -H "x-api-key: YOUR_KEY"
```

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

### Configure Skip Intro Range for Video

Source: https://flyfile.app/api-docs

Set the start and end times (in seconds) for the 'Skip Intro' button in a video player. Send null for 'introEnd' to disable the feature.

```bash
curl -X PATCH https://api.flyfile.app/api/v1/files/123/intro \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"introStart": 0, "introEnd": 90}'
```

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

### List Folders in Root Directory

Source: https://flyfile.app/api-docs

Fetch a list of all directories within your root folder. This cURL example demonstrates a basic GET request requiring your API key.

```curl
curl https://api.flyfile.app/api/v1/folders \
  -H "x-api-key: YOUR_KEY"
```

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

### Get Account Details

Source: https://flyfile.app/api-docs

Retrieve your storage usage, financial balance, and account details. Requires API key authentication.

```APIDOC
## GET /account

### Description
Retrieve your storage usage, financial balance, and account details.

### Method
GET

### Endpoint
/account

### Parameters
#### Headers
- **x-api-key** (string) - Required - Your unique API key.

### Request Example
```
curl -X GET https://api.flyfile.app/api/v1/account \
  -H "x-api-key: YOUR_KEY"
```

### Response
#### Success Response (200)
- **email** (string) - The account email address.
- **balance** (number) - The account's financial balance.
- **totalFiles** (integer) - The total number of files associated with the account.
- **totalViews** (integer) - The total number of views across all files.

#### Response Example
```json
{
  "email": "dev@acme.com",
  "balance": 150.75,
  "totalFiles": 482,
  "totalViews": 92050
}
```
```

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

### Get File

Source: https://flyfile.app/api-docs

Retrieves details of a specific file.

```APIDOC
## GET /files/{file_id}

### Description
Retrieves details of a specific file.

### Method
GET

### Endpoint
/files/{file_id}

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The ID of the file to retrieve.
```

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

### Create a New Folder

Source: https://flyfile.app/api-docs

Create a new directory using a POST request. This example shows how to specify the folder name and optionally a parent directory UUID in the JSON body. The operation is idempotent.

```curl
curl -X POST https://api.flyfile.app/api/v1/folders \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Project"}'
```

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

### Get Share Links for a File

Source: https://flyfile.app/api-docs

Retrieve existing share links for a file. If no share token exists, one will be automatically generated.

```bash
curl https://api.flyfile.app/api/v1/files/123/share \
  -H "x-api-key: YOUR_KEY"
```

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

### Get Account Info

Source: https://flyfile.app/api-docs

Retrieves information about the authenticated account.

```APIDOC
## GET /account

### Description
Retrieves information about the authenticated account.

### Method
GET

### Endpoint
/account

### Parameters
No parameters are required for this endpoint.

### Request Example
```
curl -X GET "https://api.flyfile.app/api/v1/account" \
  -H "x-api-key: YOUR_KEY"
```

### Response
#### Success Response (200)
- **account_info** (object) - Details of the account.
```

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

### Get Playlist

Source: https://flyfile.app/api-docs

Retrieves details of a specific playlist.

```APIDOC
## GET /playlists/{playlist_id}

### Description
Retrieves details of a specific playlist.

### Method
GET

### Endpoint
/playlists/{playlist_id}

### Parameters
#### Path Parameters
- **playlist_id** (string) - Required - The ID of the playlist to retrieve.
```

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

### Get Full Playlist with Items

Source: https://flyfile.app/api-docs

Retrieves a specific playlist, including its ordered items and associated file metadata. Requires the playlist ID and an API key.

```bash
curl https://api.flyfile.app/api/v1/playlists/PLAYLIST-UUID -H "X-Api-Key: KEY"
```

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

### Get full playlist with ordered items

Source: https://flyfile.app/api-docs

Retrieves a complete playlist, including its ordered items and associated file metadata.

```APIDOC
## GET /playlists/:id

### Description
Get full playlist with ordered items, including file metadata and thumbnail URLs.

### Method
GET

### Endpoint
/playlists/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the playlist.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the playlist.
- **name** (string) - The name of the playlist.
- **items** (array) - An array of items in the playlist.
  - **position** (number) - The position of the item within the playlist.
  - **file** (object) - Metadata about the file.
    - **name** (string) - The name of the file.
    - **thumbnailUrl** (string) - The URL of the file's thumbnail.

### Response Example
{
  "example": "{"id": "...", "name": "...", "items": [{"position": 0, "file": {"name": "...", "thumbnailUrl": "..."}}]}"
}
```

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

### Get File Share Links

Source: https://flyfile.app/api-docs

Retrieves share links for a file. If a share token does not exist, it will be generated automatically.

```APIDOC
## GET /files/:id/share

### Description
Get share links for a file. Generates a public share token automatically if one does not exist yet.

### Method
GET

### Endpoint
/api/v1/files/:id/share

#### Path Parameters
- **id** (string) - Required - The ID of the file.

#### Headers
- **x-api-key** (string) - Required - Your API key.
```

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

### Get Share Links

Source: https://flyfile.app/api-docs

Retrieves all share links associated with a specific file.

```APIDOC
## GET /files/{file_id}/share-links

### Description
Retrieves all share links associated with a specific file.

### Method
GET

### Endpoint
/files/{file_id}/share-links

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The ID of the file.
```

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

### Get File Statistics

Source: https://flyfile.app/api-docs

Retrieve the total view count and metadata for a specific file using its ID. This helps in tracking file popularity.

```bash
curl https://api.flyfile.app/api/v1/files/123/stats
```

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

### Assign Upload Node URL

Source: https://flyfile.app/api-docs

Get the fastest regional uploader node URL. Pass the returned URL to your chunked upload requests.

```bash
curl https://api.flyfile.app/api/v1/upload/assign \
  -H "x-api-key: YOUR_KEY"
```

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

### Get Transcoding Status

Source: https://flyfile.app/api-docs

Retrieves the HLS job progress and technical media specifications for a file.

```APIDOC
## GET /files/:id/transcode

### Description
Retrieve HLS job progress and technical media specifications (codecs, audio tracks, etc.).

### Method
GET

### Endpoint
/api/v1/files/:id/transcode

#### Path Parameters
- **id** (string) - Required - The ID of the file.
```

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

### Get File Stats

Source: https://flyfile.app/api-docs

Retrieves the total view count and metadata for a specific file using its ID.

```APIDOC
## GET /files/:id/stats

### Description
Get total view count and metadata for a specific file.

### Method
GET

### Endpoint
/api/v1/files/:id/stats

#### Path Parameters
- **id** (string) - Required - The ID of the file.
```

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

### Assign Upload Node

Source: https://flyfile.app/api-docs

Gets the fastest regional uploader node URL. This URL should be used for subsequent chunked upload requests.

```APIDOC
## GET /upload/assign

### Description
Retrieves the URL of the nearest available uploader node to facilitate efficient file uploads.

### Method
GET

### Endpoint
/upload/assign

### Response
#### Success Response (200)
- **url** (string) - The URL of the uploader node.
- **serverId** (string) - The identifier of the server node.
```

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

### Get Remote Upload Job Status

Source: https://flyfile.app/api-docs

Polls the status of a specific remote upload job using its jobId.

```APIDOC
## GET /upload/remote/:jobId

### Description
Allows polling for the real-time status of a particular remote download job.

### Method
GET

### Endpoint
/upload/remote/:jobId

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the remote upload job to query.
```

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

### Get Public Folder Contents

Source: https://flyfile.app/api-docs

Retrieve the contents of a shared folder using its public token. This endpoint does not require authentication and returns folder details along with a list of READY files, including proxied thumbnail and view URLs.

```APIDOC
## GET /public/folder/:token

### Description
Public (no auth). Returns folder name and all READY files with proxied thumbnail URLs.

### Method
GET

### Endpoint
/public/folder/:token

### Parameters
#### Path Parameters
- **token** (string) - Required - The public share token for the folder.

### Request Example
```
curl https://api.flyfile.app/api/public/folder/TOKEN
```

### Response
#### Success Response (200)
- **folder** (object) - Details about the folder.
  - **id** (string) - The folder's unique identifier.
  - **name** (string) - The folder's name.
- **files** (array) - A list of files within the folder that are in READY status.
  - Each file object contains:
    - **id** (string) - The file's unique identifier.
    - **name** (string) - The file's name.
    - **thumbnailUrl** (string) - A proxied URL for the file's thumbnail.
    - **viewUrl** (string) - A proxied URL for viewing the file.

#### Response Example
```json
{
  "folder": {"id": "...", "name": "Movies"},
  "files": [{"id": "123", "name": "film.mp4", "thumbnailUrl": "https://...", "viewUrl": "https://..."}]
}
```
```

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

### Retrieve HLS Transcoding Status

Source: https://flyfile.app/api-docs

Get the progress of HLS optimizations and detailed media specifications for a file. This includes job status, quality, and technical details.

```bash
curl https://api.flyfile.app/api/v1/files/123/transcode
```

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

### Initialize Upload

Source: https://flyfile.app/api-docs

Register the upload and receive an uploadId. File size limits apply: Free 5 GB, Pro/Ultra Pro 20 GB.

```bash
curl -X POST https://api.flyfile.app/api/v1/upload/init \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName": "vid.mp4", "fileSize": 104857600}'
```

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

### Configure Intro Skip Range

Source: https://flyfile.app/api-docs

Configures the skip intro range for a video. When set, the player displays a 'Skip Intro' button during the specified range. Sending null for `introEnd` disables this feature.

```APIDOC
## PATCH /files/:id/intro

### Description
Configure the skip intro range for a video. When set, the player displays a "Skip Intro" button during the specified range.

### Method
PATCH

### Endpoint
/api/v1/files/:id/intro

#### Path Parameters
- **id** (string) - Required - The ID of the video file.

#### Headers
- **x-api-key** (string) - Required - Your API key.

#### Request Body
- **introStart** (float) - Optional - Second where the intro begins. Defaults to 0 if omitted.
- **introEnd** (float) - Optional - Second where the intro ends. The player shows a "Skip Intro" button while the playhead is within [introStart, introEnd). Send null to disable.
```

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

### Create New Playlist

Source: https://flyfile.app/api-docs

Creates a new playlist with a required name and an optional description. Requires an API key.

```bash
curl -X POST https://api.flyfile.app/api/v1/playlists \
  -H "X-Api-Key: KEY" \
  -d '{"name": "Best of 2025"}'
```

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

### Init Upload

Source: https://flyfile.app/api-docs

Initializes a file upload process.

```APIDOC
## POST /uploads/init

### Description
Initializes a file upload process.

### Method
POST

### Endpoint
/uploads/init

### Parameters
#### Request Body
- **file_name** (string) - Required - The name of the file to be uploaded.
- **file_size** (integer) - Required - The size of the file in bytes.
- **folder_id** (string) - Optional - The ID of the folder to upload the file to.
```

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

### Create Playlist

Source: https://flyfile.app/api-docs

Creates a new playlist.

```APIDOC
## POST /playlists

### Description
Creates a new playlist.

### Method
POST

### Endpoint
/playlists

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new playlist.
```

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

### Complete Upload

Source: https://flyfile.app/api-docs

Finalize the upload. Videos move to PROCESSING (encoding queued); other files to READY immediately.

```bash
curl -X POST https://api.flyfile.app/api/v1/upload/complete \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"uploadId": "9988776655443322"}'
```

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

### Search for Files by Name

Source: https://flyfile.app/api-docs

Use the qstring parameter to search for files by name. This is useful for finding specific files within your storage.

```bash
curl https://api.flyfile.app/api/v1/files/search?q=movie
```

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

### Retrieve Account Details

Source: https://flyfile.app/api-docs

Use this cURL command to fetch your storage usage, financial balance, and account information. Ensure you replace 'YOUR_KEY' with your actual API key.

```curl
curl -X GET https://api.flyfile.app/api/v1/account \
  -H "x-api-key: YOUR_KEY"
```

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

### Create Folder

Source: https://flyfile.app/api-docs

Creates a new folder within the account.

```APIDOC
## POST /folders

### Description
Creates a new folder within the account.

### Method
POST

### Endpoint
/folders

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new folder.
- **parent_id** (string) - Optional - The ID of the parent folder if creating a subfolder.
```

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

### Create a new playlist

Source: https://flyfile.app/api-docs

Creates a new playlist with a specified name and an optional description.

```APIDOC
## POST /playlists

### Description
Create a new playlist.

### Method
POST

### Endpoint
/playlists

### Parameters
#### Request Body
- **name** (string) - Required - Playlist name.
- **description** (string) - Optional - Playlist description.

### Request Example
{
  "example": "{\"name\": \"Best of 2025\"}"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the newly created playlist.
- **name** (string) - The name of the playlist.
- **userId** (number) - The ID of the user who created the playlist.

### Response Example
{
  "example": "{"id": "uuid", "name": "Best of 2025", "userId": 1}"
}
```

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

### Create Folder

Source: https://flyfile.app/api-docs

Create a new directory. This operation is idempotent; it returns the existing folder if a folder with the same name and parent already exists.

```APIDOC
## POST /folders

### Description
Create a new directory. Idempotent — returns existing folder if name+parent already exists.

### Method
POST

### Endpoint
/folders

### Parameters
#### Headers
- **x-api-key** (string) - Required - Your unique API key.
- **Content-Type** (string) - Required - Must be `application/json`.
#### Request Body
- **name** (string) - Required - The desired name for the new folder.
- **parentIduuid** (string) - Optional - The UUID of the parent directory. If omitted, the folder is created in the root.

### Request Example
```
curl -X POST https://api.flyfile.app/api/v1/folders \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Project"}'
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created or existing folder.
- **name** (string) - The name of the folder.
- **parentId** (string or null) - The UUID of the parent folder, or null if it's in the root.

#### Response Example
```json
{"id": "uuid-new", "name": "New Project", "parentId": null}
```
```

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

### Enable Folder Sharing

Source: https://flyfile.app/api-docs

Generate a public share token and URL for a folder by making a POST request. This allows anyone with the link to browse contents without authentication. Calling this multiple times preserves the token.

```curl
curl -X POST https://api.flyfile.app/api/v1/folders/FOLDER-UUID/share \
  -H "X-Api-Key: YOUR_KEY"
```

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

### List Folders

Source: https://flyfile.app/api-docs

List all directories in your root or a specific parent directory. Returns an array of folder objects.

```APIDOC
## GET /folders

### Description
List all directories in your root or a specific parent. Returns an array directly.

### Method
GET

### Endpoint
/folders

### Parameters
#### Query Parameters
- **parentIduuid** (string) - Optional - Filter by parent directory UUID. Omit for root.
#### Headers
- **x-api-key** (string) - Required - Your unique API key.

### Request Example
```
curl https://api.flyfile.app/api/v1/folders \
  -H "x-api-key: YOUR_KEY"
```

### Response
#### Success Response (200)
- An array of folder objects, each containing:
  - **id** (string) - The unique identifier for the folder.
  - **name** (string) - The user-defined name of the folder.
  - **parentId** (string or null) - The UUID of the parent folder, or null if it's in the root.
  - **createdAt** (string) - ISO timestamp of when the folder was created.

#### Response Example
```json
[{"id": "uuid-1", "name": "Assets", "parentId": null, "createdAt": "2025-01-01T00:00:00.000Z"}]
```
```

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

### Initialize Upload

Source: https://flyfile.app/api-docs

Registers an upload and returns an uploadId. Supports file size limits based on subscription tiers.

```APIDOC
## POST /upload/init

### Description
Initializes a file upload process, generating a unique uploadId for tracking. It accepts file details and an optional target folder.

### Method
POST

### Endpoint
/upload/init

### Parameters
#### Request Body
- **fileName** (string) - Required - Original filename with extension.
- **fileSize** (number) - Required - File size in bytes.
- **folderId** (uuid) - Optional - The ID of the target folder for the upload.
```

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

### Set Skip Intro

Source: https://flyfile.app/api-docs

Sets or unsets the 'skip intro' flag for a video file.

```APIDOC
## PATCH /files/skip-intro

### Description
Sets or unsets the 'skip intro' flag for a video file.

### Method
PATCH

### Endpoint
/files/skip-intro

### Parameters
#### Request Body
- **file_id** (string) - Required - The ID of the file.
- **skip_intro** (boolean) - Required - Set to true to enable skip intro, false to disable.
```

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

### Use rclone to Upload Local Folder

Source: https://flyfile.app/api-docs

Upload a local folder to FlyFile using the configured rclone remote. The backend is write-only.

```bash
# Upload a local folder
rclone copy /path/to/videos flyfile:MyFolder --progress
```

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

### Fetch a Single File by ID

Source: https://flyfile.app/api-docs

Retrieve a single file's details using its BigInt ID. Requires an API key for authentication.

```bash
curl https://api.flyfile.app/api/v1/files/1234567890 \
  -H "x-api-key: YOUR_KEY"
```

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

### List Folders

Source: https://flyfile.app/api-docs

Retrieves a list of all folders accessible to the account.

```APIDOC
## GET /folders

### Description
Retrieves a list of all folders accessible to the account.

### Method
GET

### Endpoint
/folders

### Parameters
No parameters are required for this endpoint.

### Response
#### Success Response (200)
- **folders** (array) - A list of folder objects.
```

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

### Retrieve Paginated Files

Source: https://flyfile.app/api-docs

Fetches files with pagination and optional status filtering. Each file includes sharing information. Requires an API key.

```bash
curl https://api.flyfile.app/api/v1/files?limit=200&status=ready
```

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

### Create Share Link

Source: https://flyfile.app/api-docs

Creates a new share link for a specific file.

```APIDOC
## POST /files/{file_id}/share-links

### Description
Creates a new share link for a specific file.

### Method
POST

### Endpoint
/files/{file_id}/share-links

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The ID of the file.
#### Request Body
- **expires_at** (string) - Optional - The expiration date/time for the share link (ISO 8601 format).
- **permissions** (string) - Optional - Permissions for the share link (e.g., 'read', 'write').
```

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

### List All Playlists

Source: https://flyfile.app/api-docs

Retrieves a list of all playlists along with the count of items in each. Requires an API key for authentication.

```bash
curl https://api.flyfile.app/api/v1/playlists -H "X-Api-Key: KEY"
```

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

### Enable Folder Sharing

Source: https://flyfile.app/api-docs

Enable public sharing for a folder, generating a unique share token and URL. This allows anyone with the link to browse the folder contents without authentication.

```APIDOC
## POST /folders/:id/share

### Description
Enable sharing for a folder. Returns a public shareToken and shareUrl. Safe to call multiple times — token is preserved once created.

### Method
POST

### Endpoint
/folders/:id/share

### Parameters
#### Path Parameters
- **id** (string) - Required - The UUID of the folder to enable sharing for.
#### Headers
- **X-Api-Key** (string) - Required - Your unique API key.

### Request Example
```
curl -X POST https://api.flyfile.app/api/v1/folders/FOLDER-UUID/share \
  -H "X-Api-Key: YOUR_KEY"
```

### Response
#### Success Response (200)
- **shareToken** (string) - The unique token for accessing the shared folder publicly.
- **shareUrl** (string) - The public URL to access the shared folder.
- **shareEnabled** (boolean) - Indicates if sharing is currently enabled for the folder.

#### Response Example
```json
{
  "shareToken": "a1b2c3d4...",
  "shareUrl": "https://flyfile.io/s/a1b2c3d4...",
  "shareEnabled": true
}
```
```

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

### Generate Public Share Token for a File

Source: https://flyfile.app/api-docs

Generate a public share token for a file. This endpoint is safe to call multiple times as it reuses existing tokens.

```bash
curl -X POST https://api.flyfile.app/api/v1/files/123/share \
  -H "x-api-key: YOUR_KEY"
```

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

### Enable Folder Sharing

Source: https://flyfile.app/api-docs

Enables sharing for a specific folder.

```APIDOC
## POST /folders/share

### Description
Enables sharing for a specific folder.

### Method
POST

### Endpoint
/folders/share

### Parameters
#### Request Body
- **folder_id** (string) - Required - The ID of the folder to enable sharing for.
```

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

### List Files

Source: https://flyfile.app/api-docs

Retrieves a list of files, optionally filtered by folder.

```APIDOC
## GET /files

### Description
Retrieves a list of files, optionally filtered by folder.

### Method
GET

### Endpoint
/files

### Parameters
#### Query Parameters
- **folder_id** (string) - Optional - The ID of the folder to list files from.
```

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

### Fetch Single File

Source: https://flyfile.app/api-docs

Fetches a single file by its BigInt ID.

```APIDOC
## GET /files/:id

### Description
Fetch a single file by its BigInt ID.

### Method
GET

### Endpoint
/api/v1/files/:id

#### Path Parameters
- **id** (string) - Required - The BigInt ID of the file.

#### Headers
- **x-api-key** (string) - Required - Your API key.
```

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

### Configure rclone FlyFile Remote

Source: https://flyfile.app/api-docs

Configure the FlyFile remote in your rclone configuration file. This backend is write-only.

```ini
[flyfile]
type = flyfile
api_url = https://api.flyfile.app
api_key = YOUR_API_KEY
```

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

### Update Playlist Metadata

Source: https://flyfile.app/api-docs

Updates the name or description of an existing playlist. Requires the playlist ID and an API key.

```bash
curl -X PATCH -d '{"name": "Updated"}' https://api.flyfile.app/api/v1/playlists/UUID -H "X-Api-Key: KEY"
```

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

### List Playlists

Source: https://flyfile.app/api-docs

Retrieves a list of all playlists created by the account.

```APIDOC
## GET /playlists

### Description
Retrieves a list of all playlists created by the account.

### Method
GET

### Endpoint
/playlists

### Parameters
No parameters are required for this endpoint.
```

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

### Use rclone to Sync S3 Bucket to FlyFile

Source: https://flyfile.app/api-docs

Sync an S3 bucket into FlyFile using the configured rclone remote. The backend is write-only.

```bash
# Sync an S3 bucket into FlyFile
rclone copy s3:my-bucket flyfile:Imports --progress
```

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

### Complete Upload

Source: https://flyfile.app/api-docs

Finalizes an upload process. For videos, it queues them for encoding; for other files, it marks them as ready.

```APIDOC
## POST /upload/complete

### Description
Marks an upload as complete. Videos will enter a processing state, while other file types will be immediately available.

### Method
POST

### Endpoint
/upload/complete

### Parameters
#### Request Body
- **uploadId** (string) - Required - The uploadId obtained from the /upload/init endpoint.
```

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

### API Key Authentication Header

Source: https://flyfile.app/api-docs

Pass your unique API key in the 'x-api-key' header for all requests to authenticate your account.

```http
x-api-key: f7a...02c
```

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

### Add File to Playlist

Source: https://flyfile.app/api-docs

Adds a file to a specific playlist.

```APIDOC
## POST /playlists/add-file

### Description
Adds a file to a specific playlist.

### Method
POST

### Endpoint
/playlists/add-file

### Parameters
#### Request Body
- **playlist_id** (string) - Required - The ID of the playlist.
- **file_id** (string) - Required - The ID of the file to add.
```

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

### List all playlists

Source: https://flyfile.app/api-docs

Retrieves a list of all playlists, including the count of items in each playlist.

```APIDOC
## GET /playlists

### Description
List all playlists with item count.

### Method
GET

### Endpoint
/playlists

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the playlist.
- **name** (string) - The name of the playlist.
- **_count** (object) - An object containing the count of items in the playlist.
  - **items** (number) - The number of items in the playlist.

### Response Example
{
  "example": "[{"id": "uuid", "name": "Favorites", "_count": {"items": 5}}]"
}
```

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

### Bulk Move Files

Source: https://flyfile.app/api-docs

Moves multiple files to a specified folder in a single request. If `folderId` is null, files are moved to the root.

```APIDOC
## POST /files/bulk-move

### Description
Move multiple files to a folder in one request.

### Method
POST

### Endpoint
/api/v1/files/bulk-move

#### Headers
- **x-api-key** (string) - Required - Your API key.

#### Request Body
- **ids** (string[]) - Required - Array of file BigInt IDs.
- **folderId** (string) - Optional - Target folder UUID. Null for root.
```

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

### Global search across all buckets

Source: https://flyfile.app/api-docs

Performs a global search across all file buckets.

```APIDOC
## GET /files/search

### Description
Global search across all buckets.

### Method
GET

### Endpoint
/files/search
```

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

### Search Files

Source: https://flyfile.app/api-docs

Searches for files based on a query string. Returns a list of matching files with their IDs and names.

```APIDOC
## GET /files/search

### Description
Searches for files based on a query string.

### Method
GET

### Endpoint
/api/v1/files/search

#### Query Parameters
- **q** (string) - Required - Name search.
```

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

### Remote URL Upload

Source: https://flyfile.app/api-docs

Initiates an upload from a remote URL.

```APIDOC
## POST /uploads/remote

### Description
Initiates an upload from a remote URL.

### Method
POST

### Endpoint
/uploads/remote

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the file to upload.
- **folder_id** (string) - Optional - The ID of the folder to upload the file to.
```

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

### Append a file to a playlist

Source: https://flyfile.app/api-docs

Appends a specified file to the end of a playlist. The position is automatically assigned.

```APIDOC
## POST /playlists/:id/items

### Description
Append a file to the playlist. Position is auto-assigned at the end.

### Method
POST

### Endpoint
/playlists/:id/items

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the playlist.

#### Request Body
- **fileId** (string) - Required - The BigInt ID of the file to append.

### Request Example
{
  "example": "{\"fileId\": \"123456\"}"
}

### Response
#### Success Response (200)
- **id** (number) - The unique identifier of the playlist item.
- **playlistId** (string) - The ID of the playlist.
- **fileId** (string) - The ID of the file.
- **position** (number) - The position of the file within the playlist.

### Response Example
{
  "example": "{"id": 1, "playlistId": "...", "fileId": "123456", "position": 0}"
}
```

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

### Access Public Folder Contents

Source: https://flyfile.app/api-docs

Retrieve a folder's name and a list of its READY files, including proxied thumbnail and view URLs, using a public folder token. No authentication is required for this endpoint.

```curl
curl https://api.flyfile.app/api/public/folder/TOKEN
```

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

### Bulk Move Files

Source: https://flyfile.app/api-docs

Moves multiple files to a different folder in a single request.

```APIDOC
## POST /files/bulk-move

### Description
Moves multiple files to a different folder in a single request.

### Method
POST

### Endpoint
/files/bulk-move

### Parameters
#### Request Body
- **file_ids** (array) - Required - An array of file IDs to move.
- **new_folder_id** (string) - Required - The ID of the destination folder.
```

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

### Complete Upload

Source: https://flyfile.app/api-docs

Completes an ongoing file upload.

```APIDOC
## POST /uploads/complete

### Description
Completes an ongoing file upload.

### Method
POST

### Endpoint
/uploads/complete

### Parameters
#### Request Body
- **upload_id** (string) - Required - The ID of the upload.
- **file_id** (string) - Required - The ID of the file.
```

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

### Rename File

Source: https://flyfile.app/api-docs

Renames an existing file.

```APIDOC
## PATCH /files

### Description
Renames an existing file.

### Method
PATCH

### Endpoint
/files

### Parameters
#### Request Body
- **file_id** (string) - Required - The ID of the file to rename.
- **new_name** (string) - Required - The new name for the file.
```

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

### Generate File Share Token

Source: https://flyfile.app/api-docs

Generates a public share token for a file. This operation is safe to call multiple times as the token will be reused if it already exists. It returns the working share URL and embed URL.

```APIDOC
## POST /files/:id/share

### Description
Generate a public share token for a file. Safe to call multiple times — token is reused if already exists. Returns working shareUrl and embedUrl.

### Method
POST

### Endpoint
/api/v1/files/:id/share

#### Path Parameters
- **id** (string) - Required - The ID of the file.

#### Headers
- **x-api-key** (string) - Required - Your API key.
```

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

### Update Playlist

Source: https://flyfile.app/api-docs

Updates an existing playlist.

```APIDOC
## PATCH /playlists/{playlist_id}

### Description
Updates an existing playlist.

### Method
PATCH

### Endpoint
/playlists/{playlist_id}

### Parameters
#### Path Parameters
- **playlist_id** (string) - Required - The ID of the playlist to update.
#### Request Body
- **name** (string) - Optional - The new name for the playlist.
```

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

### API Key Authentication with Bearer Token

Source: https://flyfile.app/api-docs

Standard Authorization header support for automation tools, using 'Bearer' followed by your API key.

```http
Authorization: Bearer f7a...02c
```

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

### Move Multiple Files to a Folder

Source: https://flyfile.app/api-docs

Move several files to a designated folder in a single request. Specify the file IDs and the target folder UUID in the JSON body.

```bash
curl -X POST https://api.flyfile.app/api/v1/files/bulk-move \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["1", "2"], "folderId": "folder-uuid"}'
```

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

### Bulk Delete Files

Source: https://flyfile.app/api-docs

Performs batch deletion of multiple assets using their BigInt IDs.

```APIDOC
## POST /files/bulk-delete

### Description
Batch deletion of assets.

### Method
POST

### Endpoint
/api/v1/files/bulk-delete

#### Headers
- **x-api-key** (string) - Required - Your API key.

#### Request Body
- **ids** (string[]) - Required - Array of file BigInt IDs.
```

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

### Append File to Playlist

Source: https://flyfile.app/api-docs

Appends a file to the end of a specified playlist. The position is automatically assigned. Requires the playlist ID, file ID, and an API key.

```bash
curl -X POST -d '{"fileId": "123456"}' https://api.flyfile.app/api/v1/playlists/UUID/items -H "X-Api-Key: KEY"
```

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

### Rename Folder

Source: https://flyfile.app/api-docs

Renames an existing folder.

```APIDOC
## PATCH /folders

### Description
Renames an existing folder.

### Method
PATCH

### Endpoint
/folders

### Parameters
#### Request Body
- **folder_id** (string) - Required - The ID of the folder to rename.
- **new_name** (string) - Required - The new name for the folder.
```

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

### Cancel Upload

Source: https://flyfile.app/api-docs

Cancel an in-progress upload and delete the incomplete file record.

```bash
curl -X DELETE https://api.flyfile.app/api/v1/upload/9988776655443322 \
  -H "x-api-key: YOUR_KEY"
```

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

### Move File

Source: https://flyfile.app/api-docs

Moves a file to a different folder. If `folderId` is null or omitted, the file will be moved to the root directory.

```APIDOC
## PATCH /files/:id/move

### Description
Move a file to a different folder.

### Method
PATCH

### Endpoint
/api/v1/files/:id/move

#### Path Parameters
- **id** (string) - Required - The ID of the file to move.

#### Headers
- **x-api-key** (string) - Required - Your API key.

#### Request Body
- **folderId** (string) - Optional - Target folder UUID. Null or omit to move to root.
```

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

### Move File

Source: https://flyfile.app/api-docs

Moves a file to a different folder.

```APIDOC
## PATCH /files/move

### Description
Moves a file to a different folder.

### Method
PATCH

### Endpoint
/files/move

### Parameters
#### Request Body
- **file_id** (string) - Required - The ID of the file to move.
- **new_folder_id** (string) - Required - The ID of the new folder.
```

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

### Move Folder

Source: https://flyfile.app/api-docs

Move a folder to a different parent directory. You can specify a new parent UUID or omit it to move the folder to the root.

```APIDOC
## PATCH /folders/:id/move

### Description
Move a folder to a different parent directory.

### Method
PATCH

### Endpoint
/folders/:id/move

### Parameters
#### Path Parameters
- **id** (string) - Required - The UUID of the folder to move.
#### Headers
- **x-api-key** (string) - Required - Your unique API key.
- **Content-Type** (string) - Required - Must be `application/json`.
#### Request Body
- **parentId** (string or null) - Optional - The UUID of the target parent directory. Null or omit to move to root.

### Request Example
```
curl -X PATCH https://api.flyfile.app/api/v1/folders/FOLDER-UUID/move \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"parentId": "target-uuid"}'
```

### Response
#### Success Response (200)
- **id** (string) - The UUID of the moved folder.
- **name** (string) - The name of the folder.
- **parentId** (string or null) - The new UUID of the parent folder, or null if it's in the root.

#### Response Example
```json
{"id": "uuid-1", "name": "Assets", "parentId": "target-uuid"}
```
```

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

### Enqueue Remote URL Download

Source: https://flyfile.app/api-docs

Enqueue remote URL downloads. Each URL is assigned a worker node and returns a jobId for polling.

```bash
curl -X POST https://api.flyfile.app/api/v1/upload/remote \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": ["https://example.com/video.mp4"]}'
```

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

### List Remote Upload Status

Source: https://flyfile.app/api-docs

List all remote upload jobs created in the last 24 hours (excludes dismissed).

```bash
curl https://api.flyfile.app/api/v1/upload/remote-status \
  -H "x-api-key: YOUR_KEY"
```

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

### Reorder Playlist

Source: https://flyfile.app/api-docs

Reorders the files within a specific playlist.

```APIDOC
## PATCH /playlists/reorder

### Description
Reorders the files within a specific playlist.

### Method
PATCH

### Endpoint
/playlists/reorder

### Parameters
#### Request Body
- **playlist_id** (string) - Required - The ID of the playlist.
- **file_ids** (array) - Required - An array of file IDs in the desired order.
```

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

### Paginated file retrieval

Source: https://flyfile.app/api-docs

Retrieves files in a paginated manner, including their share tokens, URLs, and status.

```APIDOC
## GET /files

### Description
Paginated file retrieval for your account. Each file includes a generated/reused public shareToken, fileCode, shareUrl, and embedUrl.

### Method
GET

### Endpoint
/files

### Parameters
#### Query Parameters
- **folderId** (uuid) - Optional - Target folder.
- **limit** (number) - Optional - Pagination limit.
- **status** (string) - Optional - Optional status_video filter. Use ready for watchable files.

### Response
#### Success Response (200)
- **files** (array) - An array of file objects.
  - **id** (string) - The unique identifier for the file.
  - **name** (string) - The name of the file.
  - **status** (string) - The status of the file (e.g., READY).
  - **status_video** (string) - The video status of the file (e.g., ready).
  - **shareToken** (string) - The share token for the file.
  - **fileCode** (string) - The file code.
  - **shareUrl** (string) - The shareable URL for the file.
  - **embedUrl** (string) - The embeddable URL for the file.
- **totalFiles** (number) - The total number of files.
- **totalPages** (number) - The total number of pages.
- **currentPage** (number) - The current page number.

### Response Example
{
  "example": "{\"files\": [{\"id\": \"123\", \"name\": \"movie.mp4\", \"status\": \"READY\", \"status_video\": \"ready\", \"shareToken\": \"e4V02aj4rLG6WoY\", \"fileCode\": \"e4V02aj4rLG6WoY\", \"shareUrl\": \"https://flyfile.app/v/e4V02aj4rLG6WoY\", \"embedUrl\": \"https://flyfile.app/embed/e4V02aj4rLG6WoY\"}], \"totalFiles\": 1, \"totalPages\": 1, \"currentPage\": 1}"
}
```

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

### Batch Delete Files

Source: https://flyfile.app/api-docs

Delete multiple files simultaneously by providing an array of their BigInt IDs in the JSON body. Returns the number of successfully deleted files.

```bash
curl -X POST https://api.flyfile.app/api/v1/files/bulk-delete \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["1", "2"]}'
```

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

### File Stats

Source: https://flyfile.app/api-docs

Retrieves statistics for a specific file.

```APIDOC
## GET /files/{file_id}/stats

### Description
Retrieves statistics for a specific file.

### Method
GET

### Endpoint
/files/{file_id}/stats

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The ID of the file to get stats for.
```

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

### Update playlist metadata

Source: https://flyfile.app/api-docs

Updates the metadata of an existing playlist, such as its name or description.

```APIDOC
## PATCH /playlists/:id

### Description
Update playlist metadata.

### Method
PATCH

### Endpoint
/playlists/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the playlist to update.

#### Request Body
- **name** (string) - Optional - The new name for the playlist.
- **description** (string) - Optional - The new description for the playlist.

### Request Example
{
  "example": "{\"name\": \"Updated\"}"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the updated playlist.
- **name** (string) - The updated name of the playlist.

### Response Example
{
  "example": "{"id": "...", "name": "Updated"}"
}
```

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

### Delete Folder

Source: https://flyfile.app/api-docs

Permanently delete a folder and all its contents. This action is irreversible.

```APIDOC
## DELETE /folders/:id

### Description
Permanently delete a folder.

### Method
DELETE

### Endpoint
/folders/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The UUID of the folder to delete.
#### Headers
- **x-api-key** (string) - Required - Your unique API key.

### Request Example
```
curl -X DELETE https://api.flyfile.app/api/v1/folders/FOLDER-UUID \
  -H "x-api-key: YOUR_KEY"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the deletion was successful.

#### Response Example
```json
{"success": true}
```
```

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

### Bulk Delete Files

Source: https://flyfile.app/api-docs

Deletes multiple files in a single request.

```APIDOC
## POST /files/bulk-delete

### Description
Deletes multiple files in a single request.

### Method
POST

### Endpoint
/files/bulk-delete

### Parameters
#### Request Body
- **file_ids** (array) - Required - An array of file IDs to delete.
```

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

### Reorder Playlist Items

Source: https://flyfile.app/api-docs

Reorders items within a playlist by providing a complete, ordered array of file IDs. Requires the playlist ID, an API key, and JSON content type.

```bash
curl -X PATCH https://api.flyfile.app/api/v1/playlists/UUID/items/reorder \
  -H "X-Api-Key: KEY" \
  -H "Content-Type: application/json" \
  -d '{"order": ["111", "333", "222"]}'
```

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

### Move a Folder to a New Parent

Source: https://flyfile.app/api-docs

Relocate a folder to a different parent directory by specifying the target parent UUID in the JSON body of a PATCH request. Omit or set 'parentId' to null to move to the root.

```curl
curl -X PATCH https://api.flyfile.app/api/v1/folders/FOLDER-UUID/move \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"parentId": "target-uuid"}'
```

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

### Assign Uploader

Source: https://flyfile.app/api-docs

Assigns an uploader to a file.

```APIDOC
## GET /uploads/assign-uploader

### Description
Assigns an uploader to a file.

### Method
GET

### Endpoint
/uploads/assign-uploader

### Parameters
#### Query Parameters
- **file_id** (string) - Required - The ID of the file to assign an uploader to.
```
Tokens:
Raw