Python SDK Quickstart

Find a GPU, rent it, and SSH in — all from Python or terminal in 5 minutes

circle-check

Prerequisites


Step 1: Install the SDK

pip install clore-ai

Verify installation:

clore --version

Step 2: Configure Your API Key

Option A: Environment variable (recommended)

export CLORE_API_KEY=your_api_key_here

Option B: CLI config (persisted to ~/.clore/config.json)


Step 3: Search for a GPU

CLI

You'll see a table with server IDs, GPU specs, RAM, price, and location.

Python

Output:

circle-info

Tip: The marketplace() method filters client-side. You can also filter by min_gpu_count, min_ram_gb, and available_only (default: True).


Step 4: Deploy (Rent a Server)

CLI

Python

circle-exclamation

Step 5: Connect via SSH

CLI (auto-connects)

The CLI looks up the order, finds the public IP and SSH port, and runs ssh for you.

Manual SSH


Step 6: Cleanup

When you're done, cancel the order to stop billing:

CLI

Python


Full Script: Search → Deploy → Monitor → Cancel


What's Next

Guide
What You'll Learn

Async operations, spot market, server management, error handling

Bash scripts, CI/CD integration, batch deploy

Connect AI services running on Clore to your apps

Choose the right GPU for your workload


Happy GPU renting! 🚀

Last updated

Was this helpful?