slskd API

https://slskd-api.readthedocs.io/en/latest/
Admin
slskd API is a Python library that allows users to interact with and control a slskd (Soulseek...
Tokens:6,002
Snippets:57
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install slskd-api via pip

Source: https://slskd-api.readthedocs.io/en/latest/_sources/usage.rst.txt

Use this command to install the package within your virtual environment.

```console
(.venv) $ pip install slskd-api
```

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

### get_downloads

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Gets all downloads for a specific user.

```APIDOC
## get_downloads(username)

### Description
Gets all downloads for the specified username.

### Parameters
- **username** (str) - Required - User to get downloads for.

### Returns
- **Transfer** - The transfer object.
```

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

### get_all()

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Gets the list of active and completed searches.

```APIDOC
## get_all

### Description
Gets the list of active and completed searches.

### Returns
- **list[SearchState]** - List of search states
```

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

### state(id, includeResponses=False)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Gets the state of the search corresponding to the specified id.

```APIDOC
## state

### Description
Gets the state of the search corresponding to the specified id.

### Parameters
- **id** (str) - Required - uuid of the search.
- **includeResponses** (bool) - Optional - Include responses (search result list) in the returned dict

### Returns
- **SearchState** - Info about the search
```

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

### get_uploads

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Gets all uploads for a specific user.

```APIDOC
## get_uploads(username)

### Description
Gets all uploads for the specified username.

### Parameters
- **username** (str) - Required - User to get uploads for.

### Returns
- **Transfer** - The transfer object.
```

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

### search_responses(id)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Gets search responses corresponding to the specified id.

```APIDOC
## search_responses

### Description
Gets search responses corresponding to the specified id.

### Parameters
- **id** (str) - Required - uuid of the search.

### Returns
- **list[SearchResponseItem]** - Search responses.
```

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

### Initialize SlskdClient

Source: https://slskd-api.readthedocs.io/en/latest/_sources/usage.rst.txt

Create a client instance using your host, API key, and URL base. Ensure the API key is configured in your slskd configuration file.

```python
import slskd_api
slskd = slskd_api.SlskdClient(host, api_key, url_base)
```

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

### OptionsApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for retrieving and managing application options and configuration files.

```APIDOC
## OptionsApi.get()
Gets the current application options.

## OptionsApi.get_startup()
Gets the application options provided at startup.

## OptionsApi.debug()
Gets the debug view of the current application options. Requires token authentication.

## OptionsApi.yaml_location()
Gets the path of the yaml config file. Requires remote_configuration to be true and token authentication.

## OptionsApi.download_yaml()
Gets the content of the yaml config file as text. Requires remote_configuration to be true and token authentication.

## OptionsApi.upload_yaml(yaml_content)
Sets the content of the yaml config file. Requires remote_configuration to be true and token authentication.

## OptionsApi.validate_yaml(yaml_content)
Validates the provided yaml string. Requires remote_configuration to be true and token authentication.
```

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

### SlskdClient

Source: https://slskd-api.readthedocs.io/en/latest/api.html

The main entry point for interacting with the slskd API. It requires a host and authentication credentials to initialize.

```APIDOC
## SlskdClient

### Description
The main class that allows access to the different APIs of a slskd instance. An API-Key with appropriate permissions must be set in the slskd config file, or username and password can be provided.

### Constructor
`SlskdClient(host, api_key=None, url_base='/', username=None, password=None, token=None, verify_ssl=True, timeout=None)`

### Parameters
- **host** (str) - Required - The host address of the slskd instance.
- **api_key** (str) - Optional - API key for authentication.
- **url_base** (str) - Optional - The base URL path.
- **username** (str) - Optional - Username for authentication.
- **password** (str) - Optional - Password for authentication.
- **token** (str) - Optional - Authentication token.
- **verify_ssl** (bool) - Optional - Whether to verify SSL certificates.
- **timeout** (float) - Optional - Request timeout in seconds.
```

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

### EventsApi.create

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Raises a sample event of the specified type.

```APIDOC
## EventsApi.create(event_type: str, data: str = '')

### Description
Raises a sample event of the specified type.

### Parameters
- **event_type** (Literal) - Required - The type of event to raise ('DownloadFileComplete', 'DownloadDirectoryComplete', 'UploadFileComplete', 'PrivateMessageReceived', 'RoomMessageReceived', 'Noop').
- **data** (str) - Optional - Additional event data.

### Response
- **Return Type** (bool) - True if successful.
```

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

### ApplicationApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for managing application state, versioning, and system maintenance.

```APIDOC
## ApplicationApi.state()

### Description
Gets the current state of the application.

### Returns
- **AppState** - The current application state.

## ApplicationApi.stop()

### Description
Stops the application. Requires token-based authentication (username/password); API-Key authentication will return 'Unauthorized'.

### Returns
- **bool** - True if successful.

## ApplicationApi.restart()

### Description
Restarts the application. Requires token-based authentication (username/password); API-Key authentication will return 'Unauthorized'.

### Returns
- **bool** - True if successful.

## ApplicationApi.version()

### Description
Gets the current application version.

### Returns
- **str** - The application version string.

## ApplicationApi.check_updates(forceCheck: bool = False)

### Description
Checks for available application updates.

### Parameters
- **forceCheck** (bool) - Optional - Whether to force an update check.

### Returns
- **AppVersion** - The update information.

## ApplicationApi.gc()

### Description
Forces garbage collection.

### Returns
- **bool** - True if successful.
```

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

### ServerApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for managing the server connection and retrieving server state.

```APIDOC
## ServerApi.connect()

### Description
Connects the client to the server.

### Returns
- **bool** - True if successful.

## ServerApi.disconnect()

### Description
Disconnects the client from the server.

### Returns
- **bool** - True if successful.

## ServerApi.state()

### Description
Retrieves the current state of the server.

### Returns
- **ServerState** - The current state of the server.
```

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

### SharesApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for managing and scanning file shares.

```APIDOC
## SharesApi.get_all()

### Description
Gets the current list of shares.

### Returns
- **Shares** - The list of shares.

## SharesApi.start_scan()

### Description
Initiates a scan of the configured shares.

### Returns
- **bool** - True if successful.

## SharesApi.cancel_scan()

### Description
Cancels a share scan, if one is running.

### Returns
- **bool** - True if successful.

## SharesApi.get(id)

### Description
Gets the share associated with the specified id.

### Parameters
- **id** (str) - Required

### Returns
- **ShareInfo** - The share information.

## SharesApi.all_contents()

### Description
Returns a list of all shared directories and files.

### Returns
- **list[UserDirectory]** - List of shared directories and files.

## SharesApi.contents(id)

### Description
Gets the contents of the share associated with the specified id.

### Parameters
- **id** (str) - Required

### Returns
- **list[UserDirectory]** - List of contents for the share.
```

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

### Access API endpoints

Source: https://slskd-api.readthedocs.io/en/latest/_sources/usage.rst.txt

Perform operations on the server using the initialized client instance.

```python
app_status = slskd.application.state()
available_rooms = slskd.rooms.get_all()
```

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

### browse(username: str)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves the files shared by the specified username.

```APIDOC
## browse(username: str)

### Description
Retrieves the files shared by the specified username.

### Parameters
- **username** (str) - Required - The username to browse files for.

### Response
- **Return Type** - UserUserRootDir
```

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

### directory(username: str, directory: str)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves the specified directory from the specified user.

```APIDOC
## directory(username: str, directory: str)

### Description
Retrieves the specified directory from the specified user. This returns a list (usually with a single element).

### Parameters
- **username** (str) - Required - The username to query.
- **directory** (str) - Required - The directory path to retrieve.

### Response
- **Return Type** - list[UserDirectory]
```

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

### get_download

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves details for a specific download.

```APIDOC
## get_download(username, id)

### Description
Gets the specified download.

### Parameters
- **username** (str) - Required - User to get download from.
- **id** (str) - Required - ID of the download.

### Returns
- **Transfer** - The transfer object.
```

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

### LogsApi.get()

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves the last few application logs.

```APIDOC
## LogsApi.get()

### Description
Gets the last few application logs.

### Returns
- **list[LogEntry]** - A list of log entries.
```

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

### FilesApi.get_downloads_dir

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Lists the contents of the downloads directory.

```APIDOC
## FilesApi.get_downloads_dir(recursive: bool = False)

### Description
Lists the contents of the downloads directory.

### Parameters
- **recursive** (bool) - Optional - Whether to recursively list subdirectories and files.

### Response
- **Return Type** (Directory) - The contents of the directory.
```

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

### RelayApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for managing connections and file transfers with the controller.

```APIDOC
## RelayApi.connect()
### Description
Connects to the configured controller.
### Returns
- **bool** - True if successful.

## RelayApi.disconnect()
### Description
Disconnects from the connected controller.
### Returns
- **bool** - True if successful.

## RelayApi.download_file(token: str)
### Description
Downloads a file from the connected controller.
### Parameters
- **token** (str) - Required - The file token.
### Returns
- **bool** - True if successful.

## RelayApi.upload_file(token: str)
### Description
Uploads a file from the connected controller.
### Parameters
- **token** (str) - Required - The file token.
### Returns
- **bool** - True if successful.

## RelayApi.upload_share_info(token: str)
### Description
Uploads share information to the connected controller.
### Parameters
- **token** (str) - Required - The share token.
### Returns
- **bool** - True if successful.
```

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

### SessionApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for handling user authentication and session security.

```APIDOC
## SessionApi.auth_valid()

### Description
Checks whether the provided authentication is valid.

### Returns
- **bool** - True if valid.

## SessionApi.login(username, password)

### Description
Logs in the user.

### Parameters
- **username** (str) - Required
- **password** (str) - Required

### Returns
- **SessionStatus** - Session info for the given user including token.

## SessionApi.security_enabled()

### Description
Checks whether security is enabled.

### Returns
- **bool** - True if enabled.
```

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

### info(username: str)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves information about the specified username.

```APIDOC
## info(username: str)

### Description
Retrieves information about the specified username.

### Parameters
- **username** (str) - Required - The username to retrieve info for.

### Response
- **Return Type** - UserInfo
```

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

### get_all_downloads

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves all download records.

```APIDOC
## get_all_downloads(includeRemoved=False)

### Description
Gets all downloads.

### Parameters
- **includeRemoved** (bool) - Optional - Whether to include removed downloads.

### Returns
- **list[Transfer]** - A list of transfer objects.
```

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

### enqueue

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Enqueues files for download.

```APIDOC
## enqueue(username, files)

### Description
Enqueues the specified download.

### Parameters
- **username** (str) - Required - User to download from.
- **files** (list[SearchFile]) - Required - A list of files to download.

### Returns
- **bool** - True if successful.
```

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

### RoomsApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for interacting with chat rooms, including joining, messaging, and user management.

```APIDOC
## RoomsApi.get_all_joined()
### Description
Gets all joined rooms.
### Returns
- **list[str]** - Names of the joined rooms.

## RoomsApi.join(roomName: str)
### Description
Joins a room.
### Parameters
- **roomName** (str) - Required - The name of the room.
### Returns
- **Room**

## RoomsApi.get_joined(roomName: str)
### Description
Gets the specified room.
### Parameters
- **roomName** (str) - Required - The name of the room.
### Returns
- **Room**

## RoomsApi.leave(roomName: str)
### Description
Leaves a room.
### Parameters
- **roomName** (str) - Required - The name of the room.
### Returns
- **bool** - True if successful.

## RoomsApi.send(roomName: str, message: str)
### Description
Sends a message to the specified room.
### Parameters
- **roomName** (str) - Required - The name of the room.
- **message** (str) - Required - The message content.
### Returns
- **bool** - True if successful.

## RoomsApi.get_messages(roomName: str)
### Description
Gets the current list of messages for the specified room.
### Parameters
- **roomName** (str) - Required - The name of the room.
### Returns
- **list[RoomMessage]**

## RoomsApi.set_ticker(roomName: str, ticker: str)
### Description
Sets a ticker for the specified room.
### Parameters
- **roomName** (str) - Required - The name of the room.
- **ticker** (str) - Required - The ticker text.
### Returns
- **bool** - True if successful.

## RoomsApi.add_member(roomName: str, username: str)
### Description
Adds a member to a private room.
### Parameters
- **roomName** (str) - Required - The name of the room.
- **username** (str) - Required - The username to add.
### Returns
- **bool** - True if successful.

## RoomsApi.get_users(roomName: str)
### Description
Gets the current list of users for the specified joined room.
### Parameters
- **roomName** (str) - Required - The name of the room.
### Returns
- **list[RoomUser]**

## RoomsApi.get_all()
### Description
Gets a list of rooms from the server.
### Returns
- **list[RoomInfo]**
```

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

### UsersApi

Source: https://slskd-api.readthedocs.io/en/latest/index.html

Methods for retrieving user information and browsing status.

```APIDOC
## UsersApi Methods

- `address()`
- `browse()`
- `browsing_status()`
- `directory()`
- `info()`
- `status()`
```

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

### address(username: str)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves the address of the specified username.

```APIDOC
## address(username: str)

### Description
Retrieves the address of the specified username.

### Parameters
- **username** (str) - Required - The username to retrieve the address for.

### Response
- **Return Type** - UserAddress
```

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

### FilesApi.get_incomplete_dir

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Lists the contents of the incomplete directory.

```APIDOC
## FilesApi.get_incomplete_dir(recursive: bool = False)

### Description
Lists the contents of the incomplete directory.

### Parameters
- **recursive** (bool) - Optional - Whether to recursively list subdirectories and files.

### Response
- **Return Type** (Directory) - The contents of the directory.
```

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

### FilesApi.get_incomplete_directory

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Lists the contents of the specified subdirectory within the incomplete directory.

```APIDOC
## FilesApi.get_incomplete_directory(dir_name: str, recursive: bool = False)

### Description
Lists the contents of the specified subdirectory within the incomplete directory.

### Parameters
- **dir_name** (str) - Required - The name of the subdirectory.
- **recursive** (bool) - Optional - Whether to recursively list subdirectories and files.

### Response
- **Return Type** (Directory) - The contents of the directory.
```

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

### search_text(searchText, id=None, fileLimit=10000, filterResponses=True, maximumPeerQueueLength=1000000, minimumPeerUploadSpeed=0, minimumResponseFileCount=1, responseLimit=100, searchTimeout=15000)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Performs a search for the specified request.

```APIDOC
## search_text

### Description
Performs a search for the specified request.

### Parameters
- **searchText** (str) - Required - Search query
- **id** (str) - Optional - uuid of the search. One will be generated if None.
- **fileLimit** (int) - Optional - Max number of file results
- **filterResponses** (bool) - Optional - Filter unreachable users from the results
- **maximumPeerQueueLength** (int) - Optional - Max queue length
- **minimumPeerUploadSpeed** (int) - Optional - Min upload speed in bit/s
- **minimumResponseFileCount** (int) - Optional - Min number of matching files per user
- **responseLimit** (int) - Optional - Max number of users results
- **searchTimeout** (int) - Optional - Search timeout in ms

### Returns
- **SearchState** - Info about the search
```

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

### FilesApi.get_downloaded_directory

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Lists the contents of the specified subdirectory within the downloads directory.

```APIDOC
## FilesApi.get_downloaded_directory(dir_name: str, recursive: bool = False)

### Description
Lists the contents of the specified subdirectory within the downloads directory.

### Parameters
- **dir_name** (str) - Required - The name of the subdirectory.
- **recursive** (bool) - Optional - Whether to recursively list subdirectories and files.

### Response
- **Return Type** (Directory) - The contents of the directory.
```

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

### TransfersApi

Source: https://slskd-api.readthedocs.io/en/latest/index.html

Methods for managing file downloads and uploads.

```APIDOC
## TransfersApi Methods

- `cancel_download()`
- `get_download()`
- `remove_completed_downloads()`
- `cancel_upload()`
- `get_upload()`
- `remove_completed_uploads()`
- `enqueue()`
- `get_downloads()`
- `get_all_downloads()`
- `get_queue_position()`
- `get_all_uploads()`
- `get_uploads()`
```

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

### get_upload

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves details for a specific upload.

```APIDOC
## get_upload(username, id)

### Description
Gets the specified upload.

### Parameters
- **username** (str) - Required - User to get upload from.
- **id** (str) - Required - ID of the upload.

### Returns
- **Transfer** - The transfer object.
```

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

### status(username: str)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves status for the specified username.

```APIDOC
## status(username: str)

### Description
Retrieves status for the specified username.

### Parameters
- **username** (str) - Required - The username to retrieve status for.

### Response
- **Return Type** - UserStatus
```

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

### get_all_uploads

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves all upload records.

```APIDOC
## get_all_uploads(includeRemoved=False)

### Description
Gets all uploads.

### Parameters
- **includeRemoved** (bool) - Optional - Whether to include removed uploads.

### Returns
- **list[Transfer]** - A list of transfer objects.
```

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

### browsing_status(username: str)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves the status of the current browse operation for the specified username.

```APIDOC
## browsing_status(username: str)

### Description
Retrieves the status of the current browse operation for the specified username, if any. Will return error 404 if called after the browsing operation has ended.

### Parameters
- **username** (str) - Required - The username to check browsing status for.

### Response
- **Return Type** - BrowsingStatus
```

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

### EventsApi.get

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Retrieves a paginated list of past event records.

```APIDOC
## EventsApi.get(start: int = 0, limit: int = 100)

### Description
Retrieves a paginated list of past event records.

### Parameters
- **start** (int) - Optional - The offset (number of records) at which to start the requested page.
- **limit** (int) - Optional - The page size.

### Response
- **Return Type** (list[Event]) - A list of event records.
```

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

### TelemetryApi

Source: https://slskd-api.readthedocs.io/en/latest/index.html

Methods for retrieving telemetry and transfer statistics.

```APIDOC
## TelemetryApi Methods

- `get_transfer_summary()`
- `get_transfer_histogram()`
- `get_transfer_leaderboard()`
- `get_user_transfers()`
- `get_transfer_exceptions()`
- `get_transfer_exceptions_pareto()`
- `get_most_dl_directories()`
```

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

### get_queue_position

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Checks the queue position for a download.

```APIDOC
## get_queue_position(username, id)

### Description
Gets the download for the specified username matching the specified filename, and requests the current place in the remote queue.

### Parameters
- **username** (str) - Required - User to check queue for.
- **id** (str) - Required - ID of the download.

### Returns
- **Union[int, str]** - Queue position or error message.
```

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

### ConversationsApi Methods

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Methods for managing user conversations and private messages.

```APIDOC
## ConversationsApi.acknowledge(username: str, id: int)

### Description
Acknowledges a specific message ID for a given username.

### Returns
- **bool** - True if successful.

## ConversationsApi.acknowledge_all(username: str)

### Description
Acknowledges all messages from a specific username.

### Returns
- **bool** - True if successful.

## ConversationsApi.delete(username: str)

### Description
Closes the conversation associated with the specified username.

### Returns
- **bool** - True if successful.

## ConversationsApi.get(username: str, includeMessages: bool = True)

### Description
Retrieves the conversation for a specific username.

### Returns
- **Conversation** - The conversation object.

## ConversationsApi.send(username: str, message: str)

### Description
Sends a private message to the specified username.

### Returns
- **bool** - True if successful.

## ConversationsApi.get_all(includeInactive: bool = False, unAcknowledgedOnly: bool = False)

### Description
Retrieves all active conversations.

### Returns
- **list[Conversation]** - A list of conversation objects.

## ConversationsApi.get_messages(username: str, unAcknowledgedOnly: bool = False)

### Description
Retrieves all messages associated with a specific username.

### Returns
- **list[Message]** - A list of message objects.
```

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

### cancel_download

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Cancels a specific download for a given user.

```APIDOC
## cancel_download(username, id, remove=False)

### Description
Cancels the specified download.

### Parameters
- **username** (str) - Required - User to cancel download from.
- **id** (str) - Required - ID of the download.
- **remove** (bool) - Optional - Whether to remove the download record.

### Returns
- **bool** - True if successful.
```

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

### FilesApi.delete_incomplete_file

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Deletes the specified file within the incomplete directory.

```APIDOC
## FilesApi.delete_incomplete_file(file_name: str)

### Description
Deletes the specified file within the incomplete directory.

### Parameters
- **file_name** (str) - Required - The name of the file to delete.

### Response
- **Return Type** (bool) - True if successful.
```

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

### FilesApi.delete_incomplete_directory

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Deletes the specified subdirectory within the incomplete directory.

```APIDOC
## FilesApi.delete_incomplete_directory(dir_name: str)

### Description
Deletes the specified subdirectory within the incomplete directory.

### Parameters
- **dir_name** (str) - Required - The name of the subdirectory to delete.

### Response
- **Return Type** (bool) - True if successful.
```

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

### remove_completed_downloads

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Clears all completed download records.

```APIDOC
## remove_completed_downloads()

### Description
Removes all completed downloads, regardless of whether they failed or succeeded.

### Returns
- **bool** - True if successful.
```

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

### FilesApi.delete_downloaded_directory

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Deletes the specified subdirectory within the downloads directory.

```APIDOC
## FilesApi.delete_downloaded_directory(dir_name: str)

### Description
Deletes the specified subdirectory within the downloads directory.

### Parameters
- **dir_name** (str) - Required - The name of the subdirectory to delete.

### Response
- **Return Type** (bool) - True if successful.
```

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

### cancel_upload

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Cancels a specific upload for a given user.

```APIDOC
## cancel_upload(username, id, remove=False)

### Description
Cancels the specified upload.

### Parameters
- **username** (str) - Required - User to cancel upload from.
- **id** (str) - Required - ID of the upload.
- **remove** (bool) - Optional - Whether to remove the upload record.

### Returns
- **bool** - True if successful.
```

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

### stop(id)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Stops the search corresponding to the specified id.

```APIDOC
## stop

### Description
Stops the search corresponding to the specified id.

### Parameters
- **id** (str) - Required - uuid of the search.

### Returns
- **bool** - True if successful.
```

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

### FilesApi.delete_downloaded_file

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Deletes the specified file within the downloads directory.

```APIDOC
## FilesApi.delete_downloaded_file(file_name: str)

### Description
Deletes the specified file within the downloads directory.

### Parameters
- **file_name** (str) - Required - The name of the file to delete.

### Response
- **Return Type** (bool) - True if successful.
```

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

### delete(id)

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Deletes the search corresponding to the specified id.

```APIDOC
## delete

### Description
Deletes the search corresponding to the specified id.

### Parameters
- **id** (str) - Required - uuid of the search.

### Returns
- **bool** - True if successful.
```

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

### remove_completed_uploads

Source: https://slskd-api.readthedocs.io/en/latest/api.html

Clears all completed upload records.

```APIDOC
## remove_completed_uploads()

### Description
Removes all completed uploads, regardless of whether they failed or succeeded.

### Returns
- **bool** - True if successful.
```
Tokens:
Raw