VOE API 1

https://voe.sx/api-1-reference
Admin
VOE API 1 is a file hosting and management API that provides endpoints for account management, file...
Tokens:17,751
Snippets:61
Trust Score:9.5
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example JSON Response - Restart Upload

Source: https://voe.sx/api-1-reference/-index

An example JSON response confirming that a failed remote upload has been successfully restarted. It includes server time, status, and a queue ID for the newly initiated upload process.

```json
{
    "server_time": "2025-04-26T12:00:00",
    "msg": "OK",
    "message": "Remote upload has been restarted.",
    "status": 200,
    "success": true,
    "queueID": "UPLOAD_ENTRY_ID"
}
```

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

### Example JSON Response - Upload List

Source: https://voe.sx/api-1-reference/-index

An example of a JSON response when retrieving a list of upload URLs. It includes details about the server time, status messages, pagination information, and a list of data entries, each with its own set of attributes.

```json
{
    "server_time":"2024-04-03 00:00:00",
    "msg":"Success",
    "message":"List returned.",
    "status":200,
    "success":true,
    "list":{
       "current_page":1,
       "data":[
          {
             "id":757602,
             "folder_id":0,
             "file_code":"xxxxxxxxxx",
             "url":"https:\/\/tiktok.com?v=2457433",
             "status":3,
             "status_note":"Already completed (2).",
             "created_at":"2023-11-23T06:10:03.000000Z",
             "started_at":null,
             "updated_at":"2023-11-23T06:11:32.000000Z",
             "total_size":0,
             "loaded_size":0,
             "speed":0,
             "estimated_duration":0,
             "percent":100,
             "additional_headers":null
          }
       ],
       "first_page_url":"https:\/\/voe.sx\/api\/upload\/url\/list?page=1",
       "from":1,
       "last_page":1,
       "last_page_url":"https:\/\/voe.sx\/api\/upload\/url\/list?page=1",
       "links":[
          {
             "url":null,
             "label":"&laquo; Previous",
             "active":false
          },
          {
             "url":"https:\/\/voe.sx\/api\/upload\/url\/list?page=1",
             "label":"1",
             "active":true
          },
          {
             "url":null,
             "label":"Next &raquo;",
             "active":false
          }
       ],
       "next_page_url":null,
       "path":"https:\/\/voe.sx\/api\/upload\/url\/list",
       "per_page":100,
       "prev_page_url":null,
       "to":1,
       "total":1
    }
}
```

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

### GET /api/folder/create

Source: https://voe.sx/api-1-reference/-index

Creates a new folder in the specified parent folder.

```APIDOC
## GET /api/folder/create

### Description
Creates a new folder. You can specify the parent folder and the name for the new folder.

### Method
GET

### Endpoint
`/api/folder/create`

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **parent_id** (integer) - Required - Parent folder ID. Use 0 for the root path.
- **name** (string) - Required - The name of the new folder.

### Request Example
(No request body for GET request, parameters are in query string)

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - "OK" indicates success.
- **message** (string) - A human-readable message about the operation.
- **status** (integer) - HTTP status code (200 for success).
- **success** (boolean) - True if the request was successful.
- **result** (object) - Contains information about the created folder.
  - **fld_id** (integer) - The ID of the newly created folder.

#### Response Example
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":{
       "fld_id":1
    }
}
```
```

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

### Get Adblock Domain - cURL Example

Source: https://voe.sx/api-1-reference/-index

Retrieves the current Adblock domain and associated URL. This endpoint is intended for caching and is available for specific account types. It helps avoid redirection through the main domain.

```bash
curl -G "https://voe.sx/api/settings/domain?key=YOUR_API_KEY"
```

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

### GET /api/reseller/premium/generate

Source: https://voe.sx/api-1-reference/-index

Generates one or more Premium Keys for reseller accounts. Key duration is specified in days.

```APIDOC
## GET /api/reseller/premium/generate

### Description
Generates one or more Premium Keys. Duration is transmitted in months. Billing takes place afterwards or in advance. The keys have a validity period of 2 years after generation.

### Method
GET

### Endpoint
/api/reseller/premium/generate

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **days** (integer) - Required - Premium duration, in days. Check the reseller management panel for correct day numbers.
- **amount** (integer) - Required - The number of keys to be generated.

### Request Example
```json
{
  "key": "YOUR_API_KEY",
  "days": 30,
  "amount": 5
}
```

### Response
#### Success Response (200)
*The response structure for this endpoint is not explicitly provided in the input. It is expected to contain the generated premium keys.*

#### Response Example
*Example response structure is assumed based on the endpoint's purpose:*
```json
{
  "server_time": "2023-03-31 00:00:00",
  "msg": "OK",
  "message": "Premium keys generated successfully.",
  "status": 200,
  "success": true,
  "keys": [
    "PREMIUM_KEY_1",
    "PREMIUM_KEY_2"
  ]
}
```
```

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

### GET /api/file/set_folder

Source: https://voe.sx/api-1-reference/-index

Moves one or more files to a specified folder.

```APIDOC
## GET /api/file/set_folder

### Description
Moves file(s) to a specified folder.

### Method
GET

### Endpoint
https://voe.sx/api/file/set_folder

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **file_code** (string) - Required - The code of the file(s) to move, or a comma-separated list of file codes.
- **fld_id** (integer) - Required - The ID of the destination folder.

### Request Example
```json
{
  "request": "GET https://voe.sx/api/file/set_folder?key=YOUR_API_KEY&file_code=xxxxxx&fld_id=0"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status, e.g., "OK".
- **message** (string) - A detailed message about the operation result.
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "server_time": "2023-03-31 00:00:00",
  "msg": "OK",
  "message": "successful.",
  "status": 200,
  "success": true
}
```
```

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

### Generate Premium Keys - cURL Example

Source: https://voe.sx/api-1-reference/-index

Generates one or more premium keys for a specified duration in days and quantity. Requires an API key. The generated keys have a validity period of 2 years.

```bash
curl -G "https://voe.sx/api/reseller/premium/generate?key=YOUR_API_KEY&days=30&amount=5"
```

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

### GET /api/list

Source: https://voe.sx/api-1-reference/-index

Retrieves a list of files with specified query parameters for filtering and pagination.

```APIDOC
## GET /api/list

### Description
Retrieves a list of files with optional filtering and pagination.

### Method
GET

### Endpoint
/api/list

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **last** (integer) - Optional - Number of last files to retrieve.
- **pending** (bool) - Optional - If true, only reports with future del_time are displayed. Defaults to false.
- **pagination** (bool) - Optional - If true, pagination is used. Defaults to false. If false, a maximum of 2500 reports will be issued.

### Request Example
```json
{
  "key": "YOUR_API_KEY",
  "last": 100,
  "pending": true,
  "pagination": true
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status (e.g., "OK").
- **message** (string) - A detailed message describing the outcome (e.g., "successful.").
- **status** (integer) - The HTTP status code.
- **success** (bool) - Indicates if the request was successful.
- **result** (array) - An array of file objects (if pagination is false).
- **limit** (integer) - The maximum number of results returned when pagination is false.
- **files** (object) - Contains pagination details and file data when pagination is true.
  - **current_page** (integer)
  - **data** (array) - Array of file objects.
  - **first_page_url** (string)
  - **from** (integer)
  - **last_page** (integer)
  - **last_page_url** (string)
  - **links** (array)
  - **next_page_url** (string)
  - **path** (string)
  - **per_page** (integer)
  - **prev_page_url** (string)
  - **to** (integer)
  - **total** (integer)

#### Response Example
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":[
       {
          "file_code":"abc123456789",
          "name":"Test.mp4",
          "deleted":"2023-03-31 00:00:00",
          "del_time":"2023-03-31 00:00:00",
          "deleted_ago_sec":973
       }
    ],
    "limit":1000
}
```
```

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

### GET /api/folder/list

Source: https://voe.sx/api-1-reference/-index

Lists files within a specified folder.

```APIDOC
## GET /api/folder/list

### Description
Lists files contained within a specified folder.

### Method
GET

### Endpoint
https://voe.sx/api/folder/list

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **fld_id** (integer) - Required - The ID of the folder whose files are to be listed.

### Request Example
```json
{
  "request": "GET https://voe.sx/api/folder/list?key=YOUR_API_KEY&fld_id=0"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status, e.g., "OK".
- **message** (string) - A detailed message about the operation result.
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.
- **result** (object) - Contains the list of files and pagination information (structure similar to `/api/file/list` response).

#### Response Example
```json
{
  "server_time": "2023-03-31 00:00:00",
  "msg": "OK",
  "message": "successful.",
  "status": 200,
  "success": true,
  "result": {
    "current_page": 1,
    "data": [
      {
        "filecode": "abc123456789",
        "name": "Test.mp4",
        "title": "Test.mp4",
        "uploaded": "2023-03-31 00:00:00",
        "size": 0,
        "file_money": "0.00000"
      }
    ],
    "first_page_url": "https://voe.sx/api/folder/list?fld_id=0&page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://voe.sx/api/folder/list?fld_id=0&page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://voe.sx/api/folder/list?fld_id=0&page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "https://voe.sx/api/folder/list",
    "per_page": 100,
    "prev_page_url": null,
    "to": 5,
    "total": 5
  }
}
```
```

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

### GET /api/folder/rename

Source: https://voe.sx/api-1-reference/-index

Renames an existing folder.

```APIDOC
## GET /api/folder/rename

### Description
Renames an existing folder. You must provide the folder ID and the new name.

### Method
GET

### Endpoint
`/api/folder/rename`

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **fld_id** (integer) - Required - The ID of the folder to rename.
- **name** (string) - Required - The new name for the folder.

### Request Example
(No request body for GET request, parameters are in query string)

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - "OK" indicates success.
- **message** (string) - A human-readable message about the operation.
- **status** (integer) - HTTP status code (200 for success).
- **success** (boolean) - True if the request was successful.

#### Response Example
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true
}
```
```

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

### GET /api/folder/list

Source: https://voe.sx/api-1-reference/-index

Retrieves a list of folders and files. Supports filtering by folder ID.

```APIDOC
## GET /api/folder/list

### Description
Retrieves a list of folders and files within a specified folder or the root directory.

### Method
GET

### Endpoint
`/api/folder/list`

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **fld_id** (integer) - Optional - folder id

### Request Example
(No request body for GET request, parameters are in query string)

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - "OK" indicates success.
- **message** (string) - A human-readable message about the operation.
- **status** (integer) - HTTP status code (200 for success).
- **success** (boolean) - True if the request was successful.
- **result** (object) - Contains the list of folders and files.
  - **folders** (array) - List of folder objects.
    - **fld_id** (integer) - The ID of the folder.
    - **name** (string) - The name of the folder.
  - **files** (object) - Pagination information and list of files.
    - **current_page** (integer) - The current page number.
    - **data** (array) - List of file objects.
      - **file_code** (string) - Unique code for the file.
      - **file_fld_id** (integer) - The ID of the folder the file belongs to.
      - **name** (string) - The name of the file.
      - **title** (string) - The title of the file.
      - **views** (integer) - Number of views for the file.
      - **uploaded** (string) - Timestamp when the file was uploaded.
      - **length** (integer) - Duration of the file in seconds (for video/audio).
      - **file_size** (integer) - Size of the file in bytes.
      - **revenue** (string) - Generated revenue for the file.
      - **link** (string) - Direct link to the file.
      - **link_embed** (string) - Embeddable link for the file.
    - **first_page_url** (string) - URL for the first page of results.
    - **from** (integer) - The starting item number on the current page.
    - **last_page** (integer) - The last page number.
    - **last_page_url** (string) - URL for the last page of results.
    - **links** (array) - Pagination link objects.
      - **url** (string|null) - URL for the pagination link.
      - **label** (string) - Text label for the pagination link.
      - **active** (boolean) - Indicates if the link is for the current page.
    - **next_page_url** (string|null) - URL for the next page of results.
    - **path** (string) - The base path for the API endpoint.
    - **per_page** (integer) - Number of items per page.
    - **prev_page_url** (string|null) - URL for the previous page of results.
    - **to** (integer) - The ending item number on the current page.
    - **total** (integer) - The total number of items across all pages.

#### Response Example
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":{
       "folders":[
          {
             "fld_id":1,
             "name":"Test Folder"
          }
       ],
       "files":{
          "current_page":1,
          "data":[
             {
                "file_code":"abc123456789",
                "file_fld_id":0,
                "name":"test.mp4",
                "title":"test.mp4",
                "views":0,
                "uploaded":"2023-03-31 00:00:00",
                "length":6,
                "file_size":0,
                "revenue":"0.00000",
                "link":"https://voe.sx/abc123456789",
                "link_embed":"https://voe.sx/e/abc123456789"
             }
          ],
          "first_page_url":"https://voe.sx/api/folder/list?page=1",
          "from":1,
          "last_page":1,
          "last_page_url":"https://voe.sx/api/folder/list?page=1",
          "links":[
             {
                "url":null,
                "label":"&laquo; Previous",
                "active":false
             },
             {
                "url":"https://voe.sx/api/folder/list?page=1",
                "label":"1",
                "active":true
             },
             {
                "url":null,
                "label":"Next &raquo;",
                "active":false
             }
          ],
          "next_page_url":null,
          "path":"https://voe.sx/api/folder/list",
          "per_page":100,
          "prev_page_url":null,
          "to":3,
          "total":3
       }
    }
}
```
```

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

### Upload Subtitle - cURL Example

Source: https://voe.sx/api-1-reference/-index

Uploads a subtitle file (SRT/VTT) for a specific video using its file code. Requires an API key, the target file code, the language code, and the subtitle file itself. The response confirms the subtitle creation and provides its details.

```bash
curl -X POST "https://voe.sx/api/subtitle/upload?key=YOUR_API_KEY"
     -F "file_code=abc123456789"
     -F "language=en"
     -F "subtitle=@/path/to/your/subtitle.srt"
```

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

### Get Account Info (API v1)

Source: https://voe.sx/api-1-reference/-index

Retrieves general account information, including email, storage usage, and premium/partner status. Requires an API key.

```HTTP
GET https://voe.sx/api/account/info?key=YOUR_API_KEY
```

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

### GET /api/file/delete

Source: https://voe.sx/api-1-reference/-index

Deletes one or more files.

```APIDOC
## GET /api/file/delete

### Description
Deletes file(s) from the system.

### Method
GET

### Endpoint
https://voe.sx/api/file/delete

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **del_code** (string) - Required - The code of the file(s) to delete, or a comma-separated list of file codes.

### Request Example
```json
{
  "request": "GET https://voe.sx/api/file/delete?key=YOUR_API_KEY&del_code=xxxxxxxxxx"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status, e.g., "OK".
- **message** (string) - A detailed message about the operation result.
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "server_time": "2023-03-31 00:00:00",
  "msg": "OK",
  "message": "successful.",
  "status": 200,
  "success": true
}
```
```

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

### Example JSON Response - Clone File

Source: https://voe.sx/api-1-reference/-index

This JSON illustrates a successful response after cloning a file. It contains the server time, status messages, and details about the cloned file, including its new file code, name, and various URLs.

```json
{
   "server_time":"2023-03-31 00:00:00",
   "msg":"OK",
   "message":"successful.",
   "status":200,
   "success":true,
   "result":{
      "filecode":"abc123456789",
      "file_name":"Test.mp4",
      "url":"https:\/\/voe.sx\/abc123456789",
      "url_embed":"https:\/\/voe.sx\/e\/abc123456789"
   }
}
```

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

### Get Upload Server (API v1)

Source: https://voe.sx/api-1-reference/-index

Obtains a suitable upload server URL for direct file uploads. This is the first step in the direct upload process. Requires an API key.

```HTTP
GET https://voe.sx/api/upload/server?key=YOUR_API_KEY
```

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

### GET /api/file/list

Source: https://voe.sx/api-1-reference/-index

Retrieves a list of files. Supports pagination and filtering by upload time and name.

```APIDOC
## GET /api/file/list

### Description
Retrieves information about files. Supports pagination and filtering.

### Method
GET

### Endpoint
https://voe.sx/api/file/list

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **page** (integer) - Optional - Page number for pagination.
- **per_page** (integer) - Optional - Number of results per page.
- **fld_id** (integer) - Optional - Folder ID to filter files by.
- **created** (datetime) - Optional - Show only files uploaded after this timestamp. Can also be specified as a number to show files uploaded within the last X minutes.
- **name** (string) - Optional - Filter files by name.
- **preview** (bool) - Optional - Whether to show preview URLs.

### Request Example
```json
{
  "request": "GET https://voe.sx/api/file/list?key=YOUR_API_KEY&page=1&per_page=20&fld_id=0&created=2018-06-21%2005%3A07%3A10&name=Test123"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status, e.g., "OK".
- **message** (string) - A detailed message about the operation result.
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.
- **result** (object) - Contains the list of files and pagination information.
  - **current_page** (integer) - The current page number.
  - **data** (array) - An array of file objects.
    - **filecode** (string) - The unique code for the file.
    - **name** (string) - The name of the file.
    - **title** (string) - The title of the file.
    - **uploaded** (string) - Timestamp when the file was uploaded.
    - **size** (integer) - The size of the file.
    - **file_money** (string) - Monetary value associated with the file.
  - **first_page_url** (string) - URL for the first page of results.
  - **from** (integer) - The starting item number on the current page.
  - **last_page** (integer) - The last page number.
  - **last_page_url** (string) - URL for the last page of results.
  - **links** (array) - An array of pagination link objects.
    - **url** (string/null) - The URL for the pagination link.
    - **label** (string) - The label for the pagination link (e.g., page number, "Previous", "Next").
    - **active** (boolean) - Indicates if the link is for the current page.
  - **next_page_url** (string/null) - URL for the next page of results.
  - **path** (string) - The base path for the API endpoint.
  - **per_page** (integer) - The number of items per page.
  - **prev_page_url** (string/null) - URL for the previous page of results.
  - **to** (integer) - The ending item number on the current page.
  - **total** (integer) - The total number of items available.

#### Response Example
```json
{
  "server_time": "2023-03-31 00:00:00",
  "msg": "OK",
  "message": "successful.",
  "status": 200,
  "success": true,
  "result": {
    "current_page": 1,
    "data": [
      {
        "filecode": "abc123456789",
        "name": "Test.mp4",
        "title": "Test.mp4",
        "uploaded": "2023-03-31 00:00:00",
        "size": 0,
        "file_money": "0.00000"
      }
    ],
    "first_page_url": "https://voe.sx/api/file/list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://voe.sx/api/file/list?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://voe.sx/api/file/list?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "https://voe.sx/api/file/list",
    "per_page": 100,
    "prev_page_url": null,
    "to": 5,
    "total": 5
  }
}
```
```

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

### GET /api/file/rename

Source: https://voe.sx/api-1-reference/-index

Renames a file by updating its title.

```APIDOC
## GET /api/file/rename

### Description
Renames a file by updating its title.

### Method
GET

### Endpoint
https://voe.sx/api/file/rename

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **file_code** (string) - Required - The code of the file to rename, or a comma-separated list of file codes.
- **title** (string) - Required - The new title for the file.

### Request Example
```json
{
  "request": "GET https://voe.sx/api/file/rename?key=YOUR_API_KEY&file_code=xxxxxxxx&title=sample"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status, e.g., "OK".
- **message** (string) - A detailed message about the operation result.
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.
- **result** (string) - A message confirming the file update.

#### Response Example
```json
{
  "server_time": "2023-03-31 00:00:00",
  "msg": "OK",
  "message": "successful.",
  "status": 200,
  "success": true,
  "result": "File has been updated."
}
```
```

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

### GET /api/file/info

Source: https://voe.sx/api-1-reference/-index

Retrieves information about one or more files. This endpoint supports mass checking of up to 500 files.

```APIDOC
## GET /api/file/info

### Description
Retrieves information about file(s) or performs a mass check. Supports up to 500 files per request.

### Method
GET

### Endpoint
https://voe.sx/api/file/info

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **file_code** (string) - Required - File code(s), comma separated

### Request Example
```json
{
  "request": "GET https://voe.sx/api/file/info?key=YOUR_API_KEY&file_code=xxxxxxxxx,yyyyyyyyy"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A short message indicating the status, e.g., "OK".
- **message** (string) - A detailed message about the operation result.
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.
- **data** (array) - An array of objects, where each object contains details about a file encoding.
  - **status** (string) - The current status of the encoding process.
  - **note** (string) - Additional notes regarding the encoding status.
  - **created_at** (string) - Timestamp when the encoding was created.
  - **started_at** (string) - Timestamp when the encoding started.
  - **updated_at** (string) - Timestamp when the encoding was last updated.
  - **file_code** (string) - The unique code for the file.
  - **file_title** (string) - The title of the file.
  - **quality** (integer) - The video quality setting.
  - **error** (string/null) - Details about any errors encountered during encoding.
  - **extra** (string) - Additional information related to the encoding process.
  - **percent** (integer) - The completion percentage of the encoding process.
  - **original_details** (object) - Contains details of the original file.
    - **videoWidth** (integer) - Width of the video.
    - **videoHeight** (integer) - Height of the video.
    - **videoBitrate** (integer) - Bitrate of the video.
    - **audioBitrate** (integer) - Bitrate of the audio.
    - **videoCodec** (string) - Codec used for video.
    - **audioCodec** (string) - Codec used for audio.
    - **videoContainer** (string) - Container format of the video.

#### Response Example
```json
{
  "server_time": "2025-04-26T12:00:00",
  "msg": "OK",
  "message": "User encodings retrieved successfully.",
  "status": 200,
  "success": true,
  "data": [
    {
      "status": "ENCODING",
      "note": "In Progress",
      "created_at": "2025-04-25T15:00:00",
      "started_at": "2025-04-25T15:05:00",
      "updated_at": "2025-04-26T12:00:00",
      "file_code": "abc123456789",
      "file_title": "My Video.mp4",
      "quality": 1080,
      "error": null,
      "extra": "transcode_video_",
      "percent": 80,
      "original_details": {
        "videoWidth": 1920,
        "videoHeight": 1080,
        "videoBitrate": 5000,
        "audioBitrate": 128,
        "videoCodec": "H.264",
        "audioCodec": "AAC",
        "videoContainer": "MP4"
      }
    }
  ]
}
```
```

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

### Get File Information by File Code

Source: https://voe.sx/api-1-reference/-index

Retrieves detailed information about one or more files using their unique file codes. Supports mass checking of up to 500 files. Requires an API key for authentication.

```HTTP
GET https://voe.sx/api/file/info?key=YOUR_API_KEY&file_code=xxxxxxxxx,yyyyyyyyy
```

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

### Get Account Statistics (API v1)

Source: https://voe.sx/api-1-reference/-index

Fetches statistics for the account over the last 32 days, including views, uploads, downloads, and profit. Requires an API key.

```HTTP
GET https://voe.sx/api/account/stats?key=YOUR_API_KEY
```

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

### GET /api/settings/domain

Source: https://voe.sx/api-1-reference/-index

Retrieves the current Adblock domain. This feature is intended for webmaster or partner accounts and should be cached locally.

```APIDOC
## GET /api/settings/domain

### Description
Outputs the current Adblock domain. The entry should be cached (5 minutes) by local caching at the site operator. This feature is only available to webmaster package or partner accounts. This function serves to avoid a redirection via our main domain.

### Method
GET

### Endpoint
/api/settings/domain

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.

### Request Example
```json
{
  "key": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **domain** (string) - The current Adblock domain.
- **url** (string) - The URL associated with the domain.
- **status** (integer) - The HTTP status code.
- **success** (bool) - Indicates if the request was successful.

#### Response Example
```json
{
  "server_time":"2023-03-31 00:00:00",
  "domain":"voe.sx",
  "url":"https://voe.sx",
  "status":200,
  "success":true
}
```
```

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

### GET /api/files/deleted

Source: https://voe.sx/api-1-reference/-index

Lists deleted files. Supports filtering by number of recent files and pagination.

```APIDOC
## GET /api/files/deleted

### Description
Retrieves a list of deleted files. You can specify the number of last files to retrieve and enable pagination.

### Method
GET

### Endpoint
`/api/files/deleted`

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **last** (integer) - Optional - Number of last deleted files to retrieve.
- **pagination** (boolean) - Optional - Default value is `false`. If `true`, pagination will be used. Otherwise, a maximum of 250 file reports will be issued. `true` is recommended.

### Request Example
(No request body for GET request, parameters are in query string)

### Response
#### Success Response (200)
(The response structure can vary depending on the `pagination` parameter)

*If `pagination` is `false` or not provided:
- **server_time** (string) - The server's current time.
- **msg** (string) - "OK" indicates success.
- **message** (string) - A human-readable message about the operation.
- **status** (integer) - HTTP status code (200 for success).
- **success** (boolean) - True if the request was successful.
- **result** (array) - List of deleted file objects.
  - **file_code** (string) - Unique code for the file.
  - **name** (string) - The name of the deleted file.
  - **deleted** (string) - Timestamp when the file was deleted.
  - **del_time** (string) - Timestamp of the deletion event.
  - **deleted_ago_sec** (integer) - Time since deletion in seconds.
- **limit** (integer) - The maximum number of files returned.

*If `pagination` is `true`:
- **server_time** (string) - The server's current time.
- **msg** (string) - "OK" indicates success.
- **message** (string) - A human-readable message about the operation.
- **status** (integer) - HTTP status code (200 for success).
- **success** (boolean) - True if the request was successful.
- **files** (object) - Pagination information and list of deleted files.
  - **current_page** (integer) - The current page number.
  - **data** (array) - List of deleted file objects.
    - **file_code** (string) - Unique code for the file.
    - **name** (string) - The name of the deleted file.
    - **deleted** (string) - Timestamp when the file was deleted.
    - **del_time** (string) - Timestamp of the deletion event.
    - **deleted_ago_sec** (integer) - Time since deletion in seconds.
  - **first_page_url** (string) - URL for the first page of results.
  - **from** (integer) - The starting item number on the current page.
  - **last_page** (integer) - The last page number.
  - **last_page_url** (string) - URL for the last page of results.
  - **links** (array) - Pagination link objects.
    - **url** (string|null) - URL for the pagination link.
    - **label** (string) - Text label for the pagination link.
    - **active** (boolean) - Indicates if the link is for the current page.
  - **next_page_url** (string|null) - URL for the next page of results.
  - **path** (string) - The base path for the API endpoint.
  - **per_page** (integer) - Number of items per page.
  - **prev_page_url** (string|null) - URL for the previous page of results.
  - **to** (integer) - The ending item number on the current page.
  - **total** (integer) - The total number of items across all pages.

#### Response Example (with pagination = false)
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":[
       {
          "file_code":"abc123456789",
          "name":"Test.mp4",
          "deleted":"2023-03-31 00:00:00",
          "del_time":"2023-03-31 00:00:00",
          "deleted_ago_sec":973
       }
    ],
    "limit":250
}
```

#### Response Example (with pagination = true)
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "files":{
       "current_page":1,
       "data":[
          {
             "file_code":"abc123456789",
              "name":"Test.mp4",
              "deleted":"2023-03-31 00:00:00",
              "del_time":"2023-03-31 00:00:00",
              "deleted_ago_sec":973
          }
       ],
       "first_page_url":"https://voe.sx/api/files/deleted?page=1",
       "from":1,
       "last_page":1,
       "last_page_url":"https://voe.sx/api/files/deleted?page=1",
       "links":[
          {
             "url":null,
             "label":"&laquo; Previous",
             "active":false
          },
          {
             "url":"https://voe.sx/api/files/deleted?page=1",
             "label":"1",
             "active":true
          },
          {
             "url":null,
             "label":"Next &raquo;",
             "active":false
          }
       ],
       "next_page_url":null,
       "path":"https://voe.sx/api/files/deleted",
       "per_page":100,
       "prev_page_url":null,
       "to":5,
       "total":5
    }
}
```
```

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

### GET /api/file/clone

Source: https://voe.sx/api-1-reference/-index

Clones an existing file code. This operation is only possible if the file owner has explicitly allowed cloning for that file.

```APIDOC
## GET /api/file/clone

### Description
Clone existing file code, PROVIDED THE FILE OWNER HAS ALLOWED CLONING!

### Method
GET

### Endpoint
https://voe.sx/api/file/clone

### Parameters
#### Query Parameters
- **key** (string) - Required - API key from account settings.
- **file_code** (string) - Required - The file code of the file to clone.
- **fld_id** (integer) - Optional - Folder ID where the cloned file should be placed. If not provided, it defaults to the root folder.

### Response
#### Success Response (200)
- **server_time** (string) - The server's current time.
- **msg** (string) - A brief message indicating the outcome of the request (e.g., "OK").
- **message** (string) - A detailed message describing the result (e.g., "successful.").
- **status** (integer) - The HTTP status code.
- **success** (boolean) - Indicates whether the operation was successful.
- **result** (object) - An object containing details about the cloned file.
  - **filecode** (string) - The file code of the newly cloned file.
  - **file_name** (string) - The name of the cloned file.
  - **url** (string) - The direct URL to the cloned file.
  - **url_embed** (string) - The embeddable URL for the cloned file.

#### Response Example
```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":{
       "filecode":"abc123456789",
       "file_name":"Test.mp4",
       "url":"https://voe.sx/abc123456789",
       "url_embed":"https://voe.sx/e/abc123456789"
    }
}
```
```
Tokens:
Raw