How to use the Python SDK

Prerequisites

• An API key
• Familiarity with command-line tools
• Basic familiarity with Python; Python 3+ installed

Installation

Our Python SDK is hosted at the Python Package Index (PyPI). You can use any Python package manager, such as pip or poetry.

For example, you can add this dependency to your project’s build file:

1
pip install fluidstack
2
# or
3
poetry add fluidstack

Instantiate a client

Import FluidStack and instantiate a client with your API key:

1
from FluidStack.client import FluidStack
2

3
client = FluidStack(
4
    api_key = '<your_api_key>'
5
)

Now you can use the client to consume the API from your Python application.

Use the FluidStack client in your app

The FluidStack client simplifies making API requests. It stores the API key that you used to instantiate it, and it already knows our API server’s base URL, so you can omit those details in your requests.

The SDK also provides code hints, type hints, parameter information, and other useful functions to speed up development.

For example, compare the tabs below:

1
...
2
client.instances.create(
3
  name='my_instance',
4
  gpu_type='RTX_A6000_48GB',
5
  ssh_key='my_ssh_key'
6
)
7
...

You can see that instead of using requests or a similar module to send an HTTP request and including the endpoint path and headers each time, the FluidStack client simplifies the request for you.

Call endpoints

Requests to API endpoints are implemented in the SDK as methods of the client. For example, the GET /instances endpoint is implemented like this:

1
client.instances.list()

The code shown above does not do anything with the response from the endpoint. It is up to you to handle the response.

For example, you could simply print the entire response to the terminal:

1
print(client.instances.list())

Or you could loop through the list and print only the name and status for each instance:

1
my_instances = client.instances.list()
2
for instance in my_instances:
3
    print(f'Instance: {instance.name}, Status: {instance.status}')

See the Programmatic Instance Management tutorial for more information on using Python, TypeScript, and their respective SDKs.

Instances

1
  client.instances.list()

SSH Keys

1
  client.ssh_keys.list()

List available configurations and operating system templates

1
client.configurations.list()