Skip to main content
You can interact with the API through HTTP requests from any language or via our official Python bindings (alpha)

Authentication

Make sure to follow the previous steps described in Authentication to obtain an API key and account ID.

Installing the SGP SDK Client

To install the ScaleGP Python client, run the following command:

Configuring the Client

The SGP client can be configured with your API key and account ID. Examples on how to use the SGP client can be found in Recipes. The simplest approach is to set environment variables:
Then instantiate the client:
The SDK will automatically use the SGP_API_KEY and SGP_ACCOUNT_ID environment variables. You can also pass them explicitly:
The SGPClient constructor accepts the following parameters:

Connecting to Non-Production Environments

Use the environment parameter to connect to development or staging environments:
You can also override the URL directly via the SGP_CLIENT_BASE_URL environment variable or the base_url parameter (which takes precedence over environment).
The Scale GP Python client is under active development, and many of the features in this document rely on the latest versions. To make sure you have the latest version, run pip install scale-gp-beta --upgrade.