Overview
The Synclyz API provides a secure interface to upload, manage, and download files externally. All requests use POST unless stated otherwise. All responses are JSON.
Base URL: https://synclyz.com/api/v2/
Error Handling
All error responses return a JSON body with a _status of "error" and a message field.
| Code | Meaning |
|---|
400 | Bad input — check your request parameters. |
401 | Bad or expired token — re-authenticate via /authorize. |
403 | Permission denied for this resource. |
404 | File or folder not found. |
405 | Unexpected method — use POST unless specified. |
429 | Rate limit reached — wait before retrying. |
5xx | Server error — try again or contact support. |
/authorize
Exchange your API keys for an access_token. Store and reuse it — do not generate a new token per request.
POST
https://synclyz.com/api/v2/authorize
| Parameter | Type | Required | Description |
|---|
key1 | string | Yes | API key 1 (64 characters) |
key2 | string | Yes | API key 2 (64 characters) |
{"data":{"access_token":"YOUR_TOKEN","account_id":"158642"},"_status":"success"}
/disable_access_token
Invalidate the current access token. Call this on logout or security events.
POST
https://synclyz.com/api/v2/disable_access_token
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Token to invalidate |
{"_status":"success"}
/account/info
Retrieve basic information about the authenticated account.
POST
https://synclyz.com/api/v2/account/info
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
{"data":{"username":"...","email":"...","account_type":"premium","storage_used_bytes":1073741824,"storage_limit_bytes":5368709120},"_status":"success"}
/account/package
Get the current account package and subscription details.
POST
https://synclyz.com/api/v2/account/package
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
{"data":{"package_label":"Premium","expiry_date":"YYYY-MM-DD"},"_status":"success"}
/file/upload
Upload a file. Send as multipart/form-data.
POST
https://synclyz.com/api/v2/file/upload
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file | file | Yes | File to upload (multipart) |
folder_id | int | No | Target folder ID — 0 for root |
{"data":{"file_hash":"abc123","file_url":"https://synclyz.com/abc123","short_url":"abc123","filesize":204800,"original_filename":"document.pdf"},"_status":"success"}
/file/download
Get a direct download URL for a file.
POSThttps://synclyz.com/api/v2/file/download
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file_hash | string | Yes | File hash / short URL |
{"data":{"download_url":"https://...","expires_in":3600},"_status":"success"}
/file/info
POSThttps://synclyz.com/api/v2/file/info
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file_hash | string | Yes | File hash / short URL |
{"data":{"file_hash":"abc123","original_filename":"document.pdf","filesize":204800,"date_uploaded":"YYYY-MM-DD","downloads":142},"_status":"success"}
/file/edit
POSThttps://synclyz.com/api/v2/file/edit
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file_hash | string | Yes | File to edit |
file_title | string | No | New display name |
file_description | string | No | Description |
file_password | string | No | Access password |
{"_status":"success"}
/file/delete
POSThttps://synclyz.com/api/v2/file/delete
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file_hash | string | Yes | File to delete |
{"_status":"success"}
/file/move
POSThttps://synclyz.com/api/v2/file/move
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file_hash | string | Yes | File to move |
folder_id | int | Yes | Destination folder ID |
{"_status":"success"}
/file/copy
POSThttps://synclyz.com/api/v2/file/copy
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
file_hash | string | Yes | File to copy |
folder_id | int | Yes | Destination folder ID |
{"data":{"new_file_hash":"xyz789"},"_status":"success"}
/folder/create
POSThttps://synclyz.com/api/v2/folder/create
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
folder_name | string | Yes | Name for the new folder |
folder_id | int | No | Parent folder ID — 0 for root |
{"data":{"folder_id":42},"_status":"success"}
/folder/listing
POSThttps://synclyz.com/api/v2/folder/listing
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
folder_id | int | No | Folder to list — 0 for root |
{"data":{"files":[...],"folders":[...]},"_status":"success"}
/folder/info
POSThttps://synclyz.com/api/v2/folder/info
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
folder_id | int | Yes | Folder ID to look up |
{"data":{"folder_id":42,"folder_name":"My Docs","file_count":12},"_status":"success"}
/folder/edit
POSThttps://synclyz.com/api/v2/folder/edit
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
folder_id | int | Yes | Folder to edit |
folder_name | string | Yes | New folder name |
{"_status":"success"}
/folder/delete
POSThttps://synclyz.com/api/v2/folder/delete
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
folder_id | int | Yes | Folder to delete (also deletes contents) |
{"_status":"success"}
/folder/move
POSThttps://synclyz.com/api/v2/folder/move
| Parameter | Type | Required | Description |
|---|
access_token | string | Yes | Valid access token |
folder_id | int | Yes | Folder to move |
destination_folder_id | int | Yes | Target parent folder ID |
{"_status":"success"}