VOE API 1 Reference

https://voe.sx/api-1/
Admin
VOE API 1 documentation providing reference endpoints for account management, file uploads,...
Tokens:5,324
Snippets:69
Trust Score:9.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Create Folder Example Response

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

Example JSON response after creating a new folder.

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

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

### Example Response: Clone File

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

This is an example JSON response when cloning a file.

```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"
   }
}
```

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

### Example Response

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

An example of a successful purchase completion response.

```json
{
    "server_time":"2024-01-01 00:00:00",
    "status":200,
    "message":"Purchase completed.",
    "keys":[
       {
          "key":"XXXXX-XXXXX-XXXXX-XXXXX",
          "days":5
       }
    ],
    "success":true
}
```

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

### List Folders Example Response

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

Example JSON response when listing folders.

```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
       }
    }
 }
```

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

### Example Response for Domain Settings

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

This is an example JSON response when retrieving the current Adblock domain settings.

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

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

### Example Response for File Listing

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

This is an example JSON response when listing files, potentially with pagination.

```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 } {    "server_time":"2023-03-31 00:00:00",    "msg":"OK",    "message":"successful.",    "status":200,    "success":true,    "files":{       "current_page":1,       "data":[          {             "title":"Test.mp4",             "name":"Test.mp4",             "file_code":"abc123456789",             "created":"2023-03-31 00:00:00",             "deleted":"2023-03-31 00:00:00",          },       ],       "first_page_url":"https://voe.sx/api/dmca/list?page=1",       "from":1,       "last_page":1,       "last_page_url":"https://voe.sx/api/dmca/list?page=1",       "links":[          {             "url":null,             "label":"&laquo; Previous",             "active":false          },          {             "url":"https://voe.sx/api/dmca/list?page=1",             "label":"1",             "active":true          },          {             "url":null,             "label":"Next &raquo;",             "active":false          }       ],       "next_page_url":null,       "path":"https://voe.sx/api/dmca/list",       "per_page":100,       "prev_page_url":null,       "to":5,       "total":5    } }
```

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

### Example Response: List Upload URLs

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

This is an example JSON response when listing upload URLs.

```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 Upload Server

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

Step 1: Get a suitable upload server.

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

```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":"https://delivery-node-***.voe-network.net/***/01"
}
```

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

### Example response for setting folder for a file

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

This JSON object confirms a successful operation to move file(s) to a specified folder.

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

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

### Rename Folder Example Response

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

Example JSON response after renaming a folder.

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

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

### Example Response: Restart Remote Upload

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

This is an example JSON response when restarting a failed remote upload.

```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 Response for Subtitle Upload

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

This is an example JSON response after successfully uploading a subtitle file.

```json
{                           "server_time": "2025-10-20 00:00:00",                           "msg": "OK",                           "message": "Subtitle has been created.",                           "status": 200,                           "success": true,                           "subtitles": [                             {                               "path": "/vtt/ABCDEFGH1234_en.srt",                               "language": "English",                               "countryCode": "en",                               "size": 0                             }                           ]                         }
```

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

### Example Response for Subtitle Deletion

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

This is an example JSON response after successfully deleting a subtitle file.

```json
{                           "server_time": "2025-10-20 00:00:00",                           "msg": "OK",                           "message": "Subtitle has been deleted.",                           "status": 200,                           "success": true,                           "subtitles": []                         }
```

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

### List Deleted Files Example Response (with pagination)

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

Example JSON response when listing deleted files with pagination enabled.

```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
    }
 }
```

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

### Example response for file list

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

This JSON object illustrates a successful response for listing files, including status for each file code.

```json
{
   "server_time":"2023-03-31 00:00:00",
   "msg":"OK",
   "message":"successful.",
   "status":200,
   "success":true,
   "result":[
      {
         "status":200,
         "fileCode":"abc123456789",
         "name":"test.mp4",
         "title":"test.mp4",
         "length":6,
         "file_size":0
      },
      {
         "status":404,
         "fileCode":"def123456789"
      }
   ]
}
```

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

### Example response for file info

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

This JSON object shows the structure of a successful response when retrieving information about file encodings.

```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"
            }
        }
    ]
}
```

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

### Example Response: Delete All Failed Remote Uploads

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

This is an example JSON response when deleting all failed remote uploads.

```json
{
    "server_time": "2025-04-26T12:00:00",
    "msg": "OK",
    "message": "3 failed remote upload(s) deleted.",
    "status": 200,
    "success": true,
    "deleted_count": 3
}
```

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

### Example response for renaming a file

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

This JSON object indicates a successful file rename operation.

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

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

### Example response for file list (paginated)

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

This JSON object shows a paginated response for listing files, detailing current page, data, and navigation links.

```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
   }
}
```

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

### Example Response: Delete Remote Upload Entry

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

This is an example JSON response when deleting a remote upload entry.

```json
{
    "server_time": "2025-04-26T12:00:00",
    "msg": "OK",
    "message": "Remote upload entry deleted successfully.",
    "status": 200,
    "success": true
}
```

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

### Account Info

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

Provides general information about the account. Cache: 5min

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

```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":{
       "email":"email@example.com",
       "balance":"0.00000",
       "storage_used":2101860825,
       "storage_left":-2028119001,
       "premium_until":"0000-00-00 00:00:00",
       "partner_until":"0000-00-00 00:00:00"
    }
}
```

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

### Upload File to Delivery Node

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

Step 2: Upload file to delivery node (form-data)

```http
POST https://delivery-node-***.voe-network.net/***/01
```

```json
{
        "success":true,
        "message":"File has been uploaded successfully.",
        "file":{
           "id":1,
           "file_code":"abc123456789",
           "file_title":"File.mp4",
           "encoding_necessary":false
        }
}
```

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

### Account Statistics

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

Statistics for the last 32 days.

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

```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":{
       "2023-02-26":{
          "date":"2023-03-31",
          "views":0,
          "views_adb":0,
          "views_vpn_proxy":0,
          "views_paid":0,
          "views_tor":0,
          "uploads":0,
          "downloads":0,
          "profit_total":0,
          "views_total":0
       }
    }
}
```

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

### Remote Upload via URL

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

Add url to remote upload queue

```http
GET/POST https://voe.sx/api/upload/url?key=YOUR_API_KEY&url=YOUR_FILE_URL
```

```json
{
    "server_time":"2023-03-31 00:00:00",
    "msg":"OK",
    "message":"successful.",
    "status":200,
    "success":true,
    "result":{
       "file_code":"abc123456789",
       "queueID": 1
    }
}
```

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

### List Remote Uploads

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

Retrieves a list of remote upload entries for the authenticated user. Supports pagination and filtering by ID.

```http
GET https://voe.sx/api/upload/url/list?key=YOUR_API_KEY
```
Tokens:
Raw