Uloz.to API

https://uloz.to/apidoc/public
Admin
Uloz.to API is a comprehensive file storage and management service providing endpoints for...
Tokens:63,041
Snippets:244
Trust Score:9.8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Login Process Information (GET /v5/auth/login-request/{token})

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Fetches information about the login process using a provided token. Requires authentication headers. Returns a JSON object indicating login status.

```json
{
  "is_logged_in": true
}
```

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

### Get User Capabilities for Files V7 (GET /v7/user/{userLogin}/files/{fileSlugs}/capabilities)

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Fetches the capabilities of a user for a given list of files. This endpoint requires the user's login and a comma-separated list of file slugs, along with authentication headers. It returns the user's permissions for the specified files.

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

### Get Folder Parents Response

Source: https://uloz.to/apidoc/public

Example response for the /v5/folder/{folderSlug}/parents-to-root endpoint, returning the target folder details and an array of parent folder objects.

```json
{
  "folder": {
    "discriminator": "folder_private",
    "name": "my best folder",
    "slug": "px0tj6f24I1A"
  },
  "parents": [
    {
      "discriminator": "folder_private",
      "name": "my best folder",
      "slug": "px0tj6f24I1A"
    }
  ]
}
```

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

### Announcements Response Sample (JSON)

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Example JSON structure for a successful response when retrieving announcements.

```JSON
{
  "news-1": {
    "id": 1,
    "source": "news",
    "content": "First <strong>breaking<\/strong> news!",
    "max_view_count": 20,
    "display_mode": "closable"
  },
  "news-2": {
    "id": 2,
    "source": "news",
    "content": "$('body').css('background-color', 'red');",
    "max_view_count": 0,
    "display_mode": "none",
    "js_condition": "1==1"
  },
  "disk-1": {
    "id": 1,
    "source": "disk",
    "content": "Buy our new shiny disk.",
    "max_view_count": -1,
    "display_mode": "visible"
  }
}
```

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

### File List Response Sample

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Example JSON response for a successful file list retrieval. Includes metadata about the request and a list of items, each with detailed file information.

```json
{
  "metadata": {
    "run_at": "2019-08-24T16:45:21+01:00",
    "offset": "50",
    "limit": "100",
    "items_count": "1842"
  },
  "items": [
    {
      "discriminator": "file_private",
      "slug": "SANqs4TMr",
      "url": "https://uloz.to/file/5aYKYQndrW3r/dmbaby-tehotenstvi-tyden-po-tydnu-1-9-tyden-mp4",
      "realm": "ulozto",
      "name": "Těhotenství týden po týdnu 1. - 9. týden.mp4",
      "name_sanitized": "Těhotenství *** po *** 1. - 9. ***.mp4",
      "extension": "mp4",
      "filesize": "23578914",
      "password_protected_file": false,
      "description": "Lorem ipsum dolor sit amet",
      "description_sanitized": "Lorem ipsum *** sit amet",
      "is_porn": false,
      "rating": 12,
      "password_protected_archive": false,
      "malware_status": "unknown",
      "content_status": "normal",
      "content_type": "video",
      "format": {
        "width": 1280,
        "height": 1024,
        "duration": 127,
        "orientation": "rotate_270"
      },
      "download_types": [
        "free"
      ],
      "thumbnail_info": [
        {}
      ],
      "preview_info": {
        "small_image": "https://previewer.greencdn.io/img/llcPfVyMSHg6?vt=1695570399&sg=kM42zixJ1CRPuMRy9ckGxA",
        "large_image": "https://previewer.greencdn.io/imgbg/llcPfVyMSHg6?vt=1695570399&sg=kM42zixJ1CRPuMRy9ckGxA",
        "video": "https://previewer.greencdn.io/vd/llcPfVyMSHg6?vt=1695570399&sg=kM42zixJ1CRPuMRy9ckGxA"
      },
      "privacy": "with_link",
      "is_porn_by_uploader": true,
      "expire_download": 20,
      "expire_time": "2019-11-13T15:24:32+01:00",
      "upload_time": "2010-11-13T15:24:32+01:00",
      "last_user_modified": "2021-10-13T18:24:31+01:00",
      "folder_slug": "e21d720f-3089-481f-987f-1556265c0c33",
      "is_incomplete": "false",
      "is_in_trash": "true",
      "processing": {
        "identify": false,
        "thumbnails": false,
        "live_preview": false,
        "archive_content": false,
        "preview": false
      }
    }
  ]
}
```

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

### Message Response Sample (JSON)

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Example JSON structure for a successful response when retrieving message details.

```JSON
{
  "author": {
    "id": "1234",
    "login": "User",
    "isDeleted": "false",
    "isSystem": "false",
    "avatar_url": "https://static.uloz.to/avatar/57ee66027d5f745f3aa1d0ea85bea13f.png"
  },
  "recipient": {
    "id": "1234",
    "login": "User",
    "isDeleted": "false",
    "isSystem": "false",
    "avatar_url": "https://static.uloz.to/avatar/57ee66027d5f745f3aa1d0ea85bea13f.png"
  },
  "id": "1234",
  "dateCreated": "2019-08-24T16:45:21+01:00",
  "message": "Hello there!",
  "isRead": "false"
}
```

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

### GET /v5/user/{userLogin}/upload-batch/{publicSlug}/capabilities

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves the capabilities and management URL for a specific upload batch.

```APIDOC
## GET /v5/user/{userLogin}/upload-batch/{publicSlug}/capabilities

### Description
Returns the capabilities and management URL for a specific upload batch identified by the user login and public slug.

### Method
GET

### Endpoint
https://apis.uloz.to/v5/user/{userLogin}/upload-batch/{publicSlug}/capabilities

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.
- **publicSlug** (string) - Required - Unique identifier for the upload batch.

### Response
#### Success Response (200)
- **private_slug** (string) - The private identifier for the batch.
- **manage_url** (string) - URL to manage the batch.

#### Response Example
{
  "private_slug": "78076536-8e61-4974-9a8a-d20620c9c97d",
  "manage_url": "https://uloz.to/tam/edit/78076536-8e61-4974-9a8a-d20620c9c97d"
}
```

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

### GET /v7/user/{userLogin}/files/{fileSlugs}/capabilities

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves specific capabilities for a list of files associated with a user.

```APIDOC
## GET /v7/user/{userLogin}/files/{fileSlugs}/capabilities

### Description
Get user capabilities for a list of files.

### Method
GET

### Endpoint
https://apis.uloz.to/v7/user/{userLogin}/files/{fileSlugs}/capabilities

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.
- **fileSlugs** (string) - Required - Comma separated list of file slugs.

#### Header Parameters
- **X-Auth-Token** (string) - Required - API key.
- **X-Checksum** (string) - Required - Access checksum.
- **X-Timestamp** (integer) - Required - Access timestamp.

### Response
#### Success Response (200)
- Returns user file capabilities.
```

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

### POST /v5/user/{userLogin}/folder-list

Source: https://uloz.to/apidoc/public

Creates multiple folders in a single batch operation.

```APIDOC
## POST /v5/user/{userLogin}/folder-list

### Description
Creates multiple folders in one batch. Recommended to call in series, not parallel. Max 1000-2000 folders per batch.

### Method
POST

### Endpoint
https://apis.uloz.to/v5/user/{userLogin}/folder-list

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Request Body
- **parent_folder_slug** (string) - Required - Slug of new parent folder.
- **children** (Array of objects) - Required - List of folder objects to create.

### Request Example
{
  "parent_folder_slug": "string",
  "children": [
    {
      "name": "string",
      "privacy": "string",
      "password": "my-password",
      "children": []
    }
  ]
}

### Response
#### Success Response (204)
- Folders created successfully.
```

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

### Free download link V5

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Provides a free download URL for a file using its hash. Includes instructions for handling captcha validation.

```APIDOC
## Free download link V5

### Description
Provides a free download URL for a file using its hash. If a `401` response with the error `120101: Captcha validation required.` is received, the user must complete the captcha validation using the `/v5/captcha/{token}` endpoint before retrying the download request.

### Method
GET (Assumed, as it provides a download link)

### Endpoint
[Endpoint not explicitly provided in text, but implies a GET request to a download link generation service]

### Parameters
[Specific parameters not detailed in the provided text, but likely includes a file hash]

### Response
#### Success Response (200)
- **link** (string) - The free download URL for the file.

#### Error Responses
- **401** Unauthorized (May include specific error codes like `120101: Captcha validation required.`)
- Other potential error codes for service unavailability or access issues.
```

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

### Get Announcements (GET)

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves a list of announcements for a given user. Requires user login and authentication tokens. Supports various response codes for success and errors.

```HTTP
GET /v1/user/{userLogin}/announcement-list HTTP/1.1
Host: apis.uloz.to
X-User-Token: YOUR_USER_TOKEN
X-Auth-Token: YOUR_AUTH_TOKEN
X-Timestamp: 1576587234
X-Checksum: 9056146304ef7a48cc13e608bb8a0621
```

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

### Create Multiple Folders (POST Request Sample)

Source: https://uloz.to/apidoc/public

This snippet provides a sample JSON payload for creating multiple folders in a batch using the POST method. It includes the parent folder slug and an array of child folder objects, each potentially containing nested structures. This allows for bulk folder creation.

```json
{
  "parent_folder_slug": "string",
  "children": [
    {
      "name": "string",
      "privacy": "string",
      "password": "my-password",
      "children": [
        { }
      ]
    }
  ]
}
```

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

### GET /v6/me - Get User Session

Source: https://uloz.to/apidoc/public

Retrieves the current user's session and associated user data. Requires a user session token for authorization.

```APIDOC
## GET /v6/me

### Description
Returns the current user's session and user data.

### Method
GET

### Endpoint
https://apis.uloz.to/v6/me

### Header Parameters
- **X-User-Token** (string) - Required - User session token, obtained from the `/v6/auth/token` endpoint.
- **X-Auth-Token** (string) - Required - API key to authorize the application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

### Responses
#### Success Response (200)
User session and user data are successfully returned.
- **country** (string) - The country code of the session.
- **is_limited_country** (string) - Indicates if the country is limited.
- **user** (object) - User information.
  - **login** (string) - User's login name.
  - **user_id** (string) - User's unique identifier.
  - **credit** (string) - User's credit balance.
  - **avatar_url** (string) - URL to the user's avatar.
  - **favorites_link** (string) - Link to the user's favorites.
  - **root_folder_slug** (string) - Slug for the user's root folder.
  - **favorites_folder_slug** (string) - Slug for the user's favorites folder.
  - **has_cloud** (string) - Indicates if the user has cloud storage.

#### Error Responses
- **401** - User not authorized.
- **403** - Forbidden.
- **429** - Too Many Requests.
- **503** - Service Unavailable.
```

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

### Get Public API Schema (GET /v5/open-api/public)

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves the OpenAPI JSON schema for the public API. Requires authentication headers. Returns a JSON object representing the API schema on success.

```json
{ }
```

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

### POST /v6/user/{userLogin}/folder

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Creates a new folder for a user and returns its information.

```APIDOC
## POST /v6/user/{userLogin}/folder

### Description
Creates a new folder for a user and returns its information.

### Method
POST

### Endpoint
/v6/user/{userLogin}/folder

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Header Parameters
- **X-User-Token** (string) - Required - User session token.
- **Accept-Language** (string) - Optional - Preferred language for validation messages and URLs.
- **X-Auth-Token** (string) - Required - API key to authorize the application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

#### Request Body
- **name** (string) - Required - Folder name (1-255 characters).
- **parent_folder_slug** (string) - Optional - Slug of the parent folder. Root folder is used if omitted.

### Request Example
```json
{
  "name": "Holiday in Hollywood",
  "parent_folder_slug": "qwerty"
}
```

### Response
#### Success Response (201)
- **discriminator** (string) - Type of the created entity (e.g., "folder_private").
- **name** (string) - The name of the created folder.
- **name_sanitized** (string) - Sanitized folder name.
- **slug** (string) - Unique identifier for the folder.
- **status** (string) - Status of the folder (e.g., "ok").
- **public_url** (string) - Public URL for the folder.
- **is_password_protected** (boolean) - Indicates if the folder is password protected.
- **type** (string) - Type of the folder (e.g., "gallery").
- **file_manager_link** (string) - Link to the file manager.
- **parent_folder_slug** (string) - Slug of the parent folder.
- **privacy** (string) - Privacy setting of the folder (e.g., "public").
- **created** (string) - Timestamp of folder creation.
- **last_user_modified** (string) - Timestamp of last user modification.
- **has_subfolder** (string) - Indicates if the folder has subfolders.
- **has_trashed_subfolders** (string) - Indicates if the folder has trashed subfolders.

#### Response Example
```json
{
  "discriminator": "folder_private",
  "name": "my best folder",
  "name_sanitized": "my *** folder",
  "slug": "px0tj6f24I1A",
  "status": "ok",
  "public_url": "/shared/folder/fOlDeRsLuG",
  "is_password_protected": false,
  "type": "gallery",
  "file_manager_link": "string",
  "parent_folder_slug": "4eqh2k",
  "privacy": "public",
  "created": "2021-08-31T15:40:16+02:00",
  "last_user_modified": "2021-08-31T15:40:16+02:00",
  "has_subfolder": "true",
  "has_trashed_subfolders": "true"
}
```
```

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

### POST /v5/user/{userLogin}/folder-list

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Creates multiple folders in a single batch. Recommended to call sequentially, not in parallel. Maximum reasonable total folders per batch is around 1000-2000.

```APIDOC
## POST /v5/user/{userLogin}/folder-list

### Description
Creates multiple folders in a single batch. Recommended to call sequentially, not in parallel. Maximum reasonable total folders per batch is around 1000-2000.

### Method
POST

### Endpoint
`https://apis.uloz.to/v5/user/{userLogin}/folder-list`

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Header Parameters
- **X-User-Token** (string) - Required - User session token. See `/v6/session`.
- **Accept-Language** (string) - Optional - Preferred language for validation messages and website URLs. Defaults to `en-US` if not present or unsupported.
- **X-Auth-Token** (string) - Required - API key to authorize the application.
- **X-Checksum** (string) - Required - Endpoint access checksum.
- **X-Timestamp** (integer) - Required - Endpoint access checksum timestamp.

#### Request Body
- **parent_folder_slug** (string) - Optional - Slug of the new parent folder.
- **children** (Array of objects) - Required - Array of folder objects to be created.
  - **name** (string) - Required - Name of the folder.
  - **privacy** (string) - Optional - Privacy setting for the folder.
  - **password** (string) - Optional - Password for the folder if privacy is set to protected.
  - **children** (Array of objects) - Optional - Nested folders.

### Request Example
```json
{
  "parent_folder_slug": "string",
  "children": [
    {
      "name": "string",
      "privacy": "string",
      "password": "my-password",
      "children": [
        { }
      ]
    }
  ]
}
```

### Response
#### Success Response (204)
Folders created successfully.

#### Error Responses
- **401** - Unauthorized.
- **403** - Forbidden.
- **404** - Not Found.
- **422** - Unprocessable Entity.
- **429** - Too Many Requests.
- **503** - Service Unavailable.
```

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

### Get File Parameters (GET)

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves publicly available parameters for a specific file using its file slug. Requires authentication, which can be provided via password, upload token, or user token headers. Returns file metadata upon success or specific codes for other scenarios.

```json
{
  "discriminator": "archive",
  "items": [
    {
      "type": "folder",
      "name": "Screen Shot.png",
      "size": "459328",
      "password_protected": false
    }
  ]
}
```

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

### Generate Fast Multi-Download Link (JSON)

Source: https://uloz.to/apidoc/public

This example shows how to request a fast multi-download link for multiple files. It involves providing device and user identification, along with a structured object defining the desired archive's folder and file slugs. Upload tokens and passwords can also be included for specific files.

```json
{
  "device_id": "your_device_id",
  "user_login": "your_user_login",
  "archive_data": {
    "folder1": [
      "fileSlug1",
      "fileSlug2"
    ],
    "folder2": [
      "fileSlug3"
    ]
  },
  "upload_tokens": {
    "fileSlug1": "token1",
    "fileSlug2": "token2"
  },
  "passwords": {
    "fileSlug3": "password3"
  }
}
```

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

### GET /v5/open-api/public

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves the OpenAPI JSON schema for the public API.

```APIDOC
## GET /v5/open-api/public

### Description
Retrieves the OpenAPI JSON schema for the public API.

### Method
GET

### Endpoint
https://apis.uloz.to/v5/open-api/public

### Parameters
#### Header Parameters
- **X-Auth-Token** (string) - Required - Api key to authorize application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

### Response
#### Success Response (200)
- **schema** (object) - OpenAPI JSON schema definition.

#### Response Example
{
  "openapi": "3.0.0",
  "info": { ... }
}
```

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

### POST /v6/user/{userLogin}/folder

Source: https://uloz.to/apidoc/public

Creates a new folder for a user and returns its information.

```APIDOC
## POST /v6/user/{userLogin}/folder

### Description
Creates a new folder for a user and returns its information.

### Method
POST

### Endpoint
/v6/user/{userLogin}/folder

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Header Parameters
- **X-User-Token** (string) - Required - User session token.
- **Accept-Language** (string) - Optional - Preferred language for validation messages and URLs.
- **X-Auth-Token** (string) - Required - API key to authorize the application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

#### Request Body
- **name** (string) - Required - Folder name (1-255 characters).
- **parent_folder_slug** (string) - Optional - Slug of the parent folder. Root folder is used if omitted.

### Request Example
```json
{
  "name": "Holiday in Hollywood",
  "parent_folder_slug": "qwerty"
}
```

### Response
#### Success Response (201)
- **discriminator** (string) - Type of the created entity (e.g., "folder_private").
- **name** (string) - The name of the created folder.
- **name_sanitized** (string) - Sanitized version of the folder name.
- **slug** (string) - Unique identifier for the folder.
- **status** (string) - Status of the folder (e.g., "ok").
- **public_url** (string) - Public URL to access the folder.
- **is_password_protected** (boolean) - Indicates if the folder is password protected.
- **type** (string) - Type of the folder (e.g., "gallery").
- **file_manager_link** (string) - Link to the file manager for the folder.
- **parent_folder_slug** (string) - Slug of the parent folder.
- **privacy** (string) - Privacy setting of the folder (e.g., "public").
- **created** (string) - Timestamp when the folder was created.
- **last_user_modified** (string) - Timestamp of the last modification by the user.
- **has_subfolder** (string) - Indicates if the folder has subfolders.
- **has_trashed_subfolders** (string) - Indicates if the folder has trashed subfolders.

#### Response Example
```json
{
  "discriminator": "folder_private",
  "name": "my best folder",
  "name_sanitized": "my *** folder",
  "slug": "px0tj6f24I1A",
  "status": "ok",
  "public_url": "/shared/folder/fOlDeRsLuG",
  "is_password_protected": false,
  "type": "gallery",
  "file_manager_link": "string",
  "parent_folder_slug": "4eqh2k",
  "privacy": "public",
  "created": "2021-08-31T15:40:16+02:00",
  "last_user_modified": "2021-08-31T15:40:16+02:00",
  "has_subfolder": "true",
  "has_trashed_subfolders": "true"
}
```
```

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

### POST /v5/user/{userLogin}/folder-list/trash-restore

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Restores multiple folders from the trash in a single bulk operation.

```APIDOC
## POST /v5/user/{userLogin}/folder-list/trash-restore

### Description
Restores a list of folders from the trash. Maximum of 1000 folders can be processed at once.

### Method
POST

### Endpoint
https://apis.uloz.to/v5/user/{userLogin}/folder-list/trash-restore

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - The user's login identifier.

#### Request Body
- **slugs** (Array of strings) - Required - Array of folder slugs to be restored.

### Request Example
{
  "slugs": ["9e8f2ec9", "90629337", "53d6db01"]
}

### Response
#### Success Response (204)
- Restore was successful.
```

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

### GET /v1/user/{userLogin}/announcement-list

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves a list of announcements for a specific user.

```APIDOC
## GET /v1/user/{userLogin}/announcement-list

### Description
Fetches all active announcements associated with the specified user login.

### Method
GET

### Endpoint
https://apis.uloz.to/v1/user/{userLogin}/announcement-list

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Header Parameters
- **X-User-Token** (string) - Required - User session token.
- **X-Auth-Token** (string) - Required - API key to authorize application.

### Response
#### Success Response (200)
- **announcements** (object) - A map of announcement objects.

#### Response Example
{
  "news-1": {
    "id": 1,
    "source": "news",
    "content": "First breaking news!",
    "max_view_count": 20,
    "display_mode": "closable"
  }
}
```

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

### GET /v5/auth/login-request/{token}

Source: https://uloz.to/apidoc/public

Checks the status of an existing login request.

```APIDOC
## GET /v5/auth/login-request/{token}

### Description
Retrieves information about the current login process status for a given token.

### Method
GET

### Endpoint
https://apis.uloz.to/v5/auth/login-request/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - The login request token.

### Response
#### Success Response (200)
- **is_logged_in** (boolean) - Indicates if the user is successfully authenticated.

#### Response Example
{
  "is_logged_in": true
}
```

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

### POST /v5/file/download-link/free

Source: https://uloz.to/apidoc/public

Retrieves a free download URL for a specified file slug.

```APIDOC
## POST /v5/file/download-link/free

### Description
Retrieves a free download URL for a specified file slug. Requires authentication headers and file identification.

### Method
POST

### Endpoint
https://apis.uloz.to/v5/file/download-link/free

### Parameters
#### Header Parameters
- **X-User-Token** (string) - Optional - User session token.
- **X-Password** (string) - Optional - BASE-64 encoded file password.
- **X-Upload-Token** (string) - Optional - Upload token for access.
- **Accept-Language** (string) - Optional - Preferred language for validation messages.
- **X-Auth-Token** (string) - Required - Api key to authorize application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

#### Request Body
- **file_slug** (string) - Required - File slug.
- **device_id** (string) - Required - Device identifying string.
- **user_login** (string) - Optional - User login.
- **captcha_token** (string) - Optional - Captcha token generated from request.

### Request Example
{
  "file_slug": "d5F1gCf",
  "device_id": "6d23jh2l8",
  "user_login": "mackousko",
  "captcha_token": "f4492eb9-5e5e-456c-a38a-042dd70f6411"
}

### Response
#### Success Response (200)
- **link** (string) - Free download URL.
- **download_url_valid_until** (string) - Expiration timestamp.
- **download_url_validity_interval** (integer) - Validity duration in seconds.
- **hash** (string) - File hash.

#### Response Example
{
  "link": "https://download.example.com/somepath?some=params",
  "download_url_valid_until": "2020-11-13T15:24:32+01:00",
  "download_url_validity_interval": 7200,
  "hash": "facfed1dc3527391e10eb8a57755dbfd"
}
```

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

### POST /v5/user/{userLogin}/folder-list/trash-restore

Source: https://uloz.to/apidoc/public

Restores multiple folders from the trash in a single bulk operation.

```APIDOC
## POST /v5/user/{userLogin}/folder-list/trash-restore

### Description
Restores multiple folders from the trash by providing an array of slugs.

### Method
POST

### Endpoint
/v5/user/{userLogin}/folder-list/trash-restore

### Parameters
#### Request Body
- **slugs** (Array of strings) - Required - Array of folder slugs to be processed (max 1000).

### Request Example
{
  "slugs": ["9e8f2ec9", "90629337", "53d6db01"]
}

### Response
#### Success Response (204)
- Restore successful.
```

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

### GET /v5/captcha/{token}

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves the current verification status of a specific captcha token.

```APIDOC
## GET /v5/captcha/{token}

### Description
Allows reading the status of a captcha token to check if it has been verified.

### Method
GET

### Endpoint
https://apis.uloz.to/v5/captcha/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - Captcha token.

#### Header Parameters
- **X-Auth-Token** (string) - Required - API key.

### Response
#### Success Response (200)
- **is_verified** (boolean) - Status of the captcha verification.

#### Response Example
{
  "is_verified": true
}
```

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

### POST /v5/file/download-link/vipdata

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Generates a VIP download link for a single file. Requires file slug, device ID, and optionally user login.

```APIDOC
## POST /v5/file/download-link/vipdata

### Description
Generates a VIP download link for a single file. Requires file slug, device ID, and optionally user login.

### Method
POST

### Endpoint
/v5/file/download-link/vipdata

### Header Parameters
- **X-User-Token** (string) - Optional - User session token.
- **X-Password** (string) - Optional - BASE-64 encoded file password.
- **X-Upload-Token** (string) - Optional - Upload token for file access.
- **Accept-Language** (string) - Optional - Preferred language for validation messages and URLs.
- **X-Auth-Token** (string) - Required - API key to authorize the application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

### Request Body
#### Parameters
- **file_slug** (string) - Required - The slug of the file.
- **device_id** (string) - Required - A string identifying the device.
- **user_login** (string | null) - Optional - The user's login.

### Request Example
```json
{
  "file_slug": "d5F1gCf",
  "device_id": "6d23jh2l8",
  "user_login": "mackousko"
}
```

### Response
#### Success Response (200)
- **link** (string) - The download URL.
- **download_url_valid_until** (string) - The expiration timestamp for the download URL.
- **download_url_validity_interval** (integer) - The validity interval of the download URL in seconds.
- **hash** (string) - The hash of the file.

#### Response Example
```json
{
  "link": "https://download.example.com/somepath?some=params",
  "download_url_valid_until": "2020-11-13T15:24:32+01:00",
  "download_url_validity_interval": 7200,
  "hash": "facfed1dc3527391e10eb8a57755dbfd"
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
- **410** Gone
- **422** Unprocessable Entity
- **429** Too Many Requests
- **451** Unavailable For Legal Reasons
- **503** Service Unavailable
```

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

### GET /v1/user/{userLogin}/announcement-list

Source: https://uloz.to/apidoc/public

Retrieves a list of announcements for a specific user.

```APIDOC
## GET /v1/user/{userLogin}/announcement-list

### Description
Fetches the list of active announcements for the specified user.

### Method
GET

### Endpoint
https://apis.uloz.to/v1/user/{userLogin}/announcement-list

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Header Parameters
- **X-User-Token** (string) - Required - User session token.
- **X-Auth-Token** (string) - Required - API key to authorize application.

### Response
#### Success Response (200)
- **announcements** (object) - List of announcements.

#### Response Example
{
  "news-1": {
    "id": 1,
    "source": "news",
    "content": "First <strong>breaking</strong> news!",
    "max_view_count": 20,
    "display_mode": "closable"
  }
}
```

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

### GET /v7/upload-batch/user/{userLogin}

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves a paginated list of all upload batches associated with a specific user.

```APIDOC
## GET /v7/upload-batch/user/{userLogin}

### Description
Fetches a list of batches for a given user with support for pagination and sorting.

### Method
GET

### Endpoint
https://apis.uloz.to/v7/upload-batch/user/{userLogin}

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.

#### Query Parameters
- **offset** (integer) - Optional - Index of first item returned (default: 0).
- **limit** (integer) - Optional - Amount of items returned (default: 50).
- **sort** (string) - Optional - Sorting of results (e.g., "-created").
```

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

### POST /v6/file-list/download-link/vipdata

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Generates a VIP download link for a list of files, allowing for structured folder creation and password protection.

```APIDOC
## POST /v6/file-list/download-link/vipdata

### Description
Generates a VIP download link for a list of files, allowing for structured folder creation and password protection. This endpoint is used to create a download link for multiple files organized in a specified folder structure.

### Method
POST

### Endpoint
https://apis.uloz.to/v6/file-list/download-link/vipdata

### Parameters
#### Header Parameters
- **X-User-Token** (string) - Optional - User session token.
- **Accept-Language** (string) - Optional - Preferred language for validation messages and website URLs.
- **X-Auth-Token** (string) - Required - API key to authorize the application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

#### Request Body
- **device_id** (string) - Required - Device identifying string.
- **user_login** (string | null) - Optional - User login.
- **archive_data** (object) - Required - Folder structure with files. Defines the organization of files within the archive.
- **upload_tokens** (object) - Optional - List of upload tokens for files, indexed by file slug.
- **passwords** (object) - Optional - List of file passwords, indexed by file slug.

### Request Example
```json
{
  "device_id": "6d23jh2l8",
  "user_login": "mackousko",
  "archive_data": {
    "muj_archiv_slozka": [
      "fileSlug1",
      "fileSlug2",
      {
        "prvni_sub_slozka": [
          "fileSlug3",
          "fileSlug4",
          {
            "druha_sub_sub_slozka": [
              "fileSlug5"
            ]
          }
        ]
      }
    ]
  },
  "upload_tokens": {
    "fileSlug1": "c1f046db-c075-4db8-8022-fdf2329f8afe:1",
    "fileSlug2": "c1f046db-c075-4db8-8022-fdf2329f8afe:2",
    "fileSlug3": "c1f046db-c075-4db8-8022-fdf2329f8afe:3"
  },
  "passwords": {
    "fileSlug1": "password",
    "fileSlug2": "secret-password",
    "fileSlug3": "super-secret-password"
  }
}
```

### Response
#### Success Response (200)
- **link** (string) - URL for downloading the archive.
- **download_url_valid_until** (string) - The timestamp until which the download URL is valid.
- **download_url_validity_interval** (integer) - The validity interval of the download URL in seconds.
- **kb_charge_amount** (integer) - The amount of KB charge for the download.
- **no_charge_until** (string) - The timestamp until which no charge will be applied.
- **archive_data** (string) - A string representation of the archive data structure.

#### Response Example
```json
{
  "link": "https://download.example.com/somepath?some=params",
  "download_url_valid_until": "2020-11-13T15:24:32+01:00",
  "download_url_validity_interval": 7200,
  "kb_charge_amount": 50128,
  "no_charge_until": "2020-11-13T15:24:32+01:00",
  "archive_data": "{'muj_archiv_slozka': {'fileSlug1', 'fileSlug2', { 'prvni_sub_slozka': { 'fileSlug3', 'fileSlug4', { 'druha_sub_sub_slozka' : {'fileSlug5'} } } } } }"
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **422** Unprocessable Entity
- **429** Too Many Requests
- **503** Service Unavailable
```

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

### GET /v6/folder/size

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Retrieves the sizes of specified folders and files. Supports recursive calculation of sizes.

```APIDOC
## GET /v6/folder/size

### Description
Get folders and files sizes of requested folders.

### Method
GET

### Endpoint
`/v6/folder/size`

### Parameters
#### Path Parameters
- **userLogin** (string) - Required - Full user login.
- **folderSlugList** (string) - Required - Folder slug list, comma-separated.

#### Query Parameters
- **recursive** (boolean) - Optional - Calculate recursive. Default: false

#### Header Parameters
- **X-User-Token** (string) - Required - User session token, see /v6/session.
- **X-Auth-Token** (string) - Required - Api key to authorize application.
- **X-Checksum** (string) - Optional - Endpoint access checksum.
- **X-Timestamp** (integer) - Optional - Endpoint access checksum timestamp.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
Folder and file sizes.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### POST /v5/file-list/download-link/vipdata

Source: https://uloz.to/apidoc/public#tag/menuUploadLink/operation/v5/upload/link%7Cpost

Generates a multi-download link for VIP users based on a list of file slugs and optional authentication tokens.

```APIDOC
## POST /v5/file-list/download-link/vipdata

### Description
Generates a VIP multi-download link for a collection of files.

### Method
POST

### Endpoint
https://apis.uloz.to/v5/file-list/download-link/vipdata

### Parameters
#### Request Body
- **archive_name** (string) - Required - Archive name without extension matching `^[-_a-zA-Z0-9]+$`.
- **device_id** (string) - Required - Device identifying string.
- **user_login** (string/null) - Optional - User login.
- **slugs** (Array) - Required - List of file slugs (max 1500).
- **upload_tokens** (object) - Optional - Upload tokens indexed by file slug.
- **passwords** (object) - Optional - File passwords indexed by file slug.

### Request Example
{
  "archive_name": "My_photos",
  "device_id": "6d23jh2l8",
  "user_login": "mackousko",
  "slugs": ["fileSlug1", "fileSlug2"],
  "upload_tokens": {"fileSlug1": "token1"},
  "passwords": {"fileSlug1": "password"}
}

### Response
#### Success Response (200)
- **link** (string) - Download URL.
- **download_url_valid_until** (string) - ISO8601 timestamp.
- **download_url_validity_interval** (integer) - Validity in seconds.
```
Tokens:
Raw