---
title: SDK Reference
sidebar_label: Overview
sidebar_position: 0
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lium.io/llms.txt
> Use this file to discover all available pages before exploring further.

<!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->

# SDK Reference

Reference documentation for the public `lium.sdk` Python API.

Install the SDK with:

```bash
pip install lium.io
```

## Client

- [Lium](/developers/sdk/reference/client/lium) - Clean Unix-style SDK for Lium.
- [AlphaQuote](/developers/sdk/reference/client/alpha-quote) - USD -&gt; alpha quote from GET /balance/convert/alpha.
- [pod_ssh_command](/developers/sdk/reference/client/pod-ssh-command) - The pod's ssh command for a shell, with the host-key options and without a key.

## Configuration

- [Config](/developers/sdk/reference/config)

## Models

- [ExecutorInfo](/developers/sdk/reference/models/executor-info)
- [PodInfo](/developers/sdk/reference/models/pod-info)
- [Template](/developers/sdk/reference/models/template) - Template information.
- [BackupConfig](/developers/sdk/reference/models/backup-config) - Backup configuration information.
- [BackupLog](/developers/sdk/reference/models/backup-log) - Backup log information.
- [RestoreLog](/developers/sdk/reference/models/restore-log) - Restore log information.
- [VolumeInfo](/developers/sdk/reference/models/volume-info) - Volume information.
- [SSHKey](/developers/sdk/reference/models/ssh-key) - Public SSH key registered for the current user.
- [RentResult](/developers/sdk/reference/models/rent-result) - What Lium.rent() chose and, unless it was a dry run, rented.

## Exceptions

- [LiumError](/developers/sdk/reference/exceptions/lium-error) - Base exception for Lium SDK.
- [LiumAuthError](/developers/sdk/reference/exceptions/lium-auth-error) - Authentication error.
- [LiumRateLimitError](/developers/sdk/reference/exceptions/lium-rate-limit-error) - Rate limit exceeded.
- [LiumServerError](/developers/sdk/reference/exceptions/lium-server-error) - Server error.
- [LiumNotFoundError](/developers/sdk/reference/exceptions/lium-not-found-error) - Resource not found (404).
- [LiumPermissionError](/developers/sdk/reference/exceptions/lium-permission-error) - The account is not allowed to do this (403).
- [PodStartError](/developers/sdk/reference/exceptions/pod-start-error) - A pod reached a state from which it will never become ready.
- [LiumHostKeyError](/developers/sdk/reference/exceptions/lium-host-key-error) - A pod presented an SSH host key that differs from the pinned one.
- [LiumInsufficientBalanceError](/developers/sdk/reference/exceptions/lium-insufficient-balance-error) - The account cannot pay for this (403 with a balance reason).
- [RemoteExecutionError](/developers/sdk/reference/exceptions/remote-execution-error) - A function offloaded with @lium.machine did not return a result from the pod.

## Result Codec

- [ResultEncodingError](/developers/sdk/reference/result_codec/result-encoding-error) - The function's result holds a value that does not travel back from the pod.

## Decorators

- [machine](/developers/sdk/reference/decorators/machine) - Decorator to execute a function on a remote Lium machine.