Skip to main content

Developer Quickstart

Get started in 5 min​

This guide takes you from zero to your first authenticated API call against the Lium platform API.

Step 1 — Get an API key​

  1. Log in to lium.io.
  2. Navigate to Settings → API Keys.
  3. Click Create API Key, copy the key, and store it securely.

Step 2 — Make your first request​

List available templates (public endpoint, no auth required):

curl https://lium.io/api/templates

List your pods (requires API key):

export LIUM_API_KEY=your_api_key_here

curl https://lium.io/api/pods \
  -H "X-API-Key: $LIUM_API_KEY"

Step 3 — Create a pod​

curl -X POST https://lium.io/api/pods \
  -H "X-API-Key: $LIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "machine_id": "<machine_uuid>",
    "template_id": "<template_uuid>",
    "gpu_count": 1,
    "ssh_key_ids": ["<ssh_key_uuid>"]
  }'

The response includes a pod_id. Poll GET /pods/{pod_id} until status is running.

End state: You have a running pod created via the API. The live OpenAPI reference is available at lium.io/documents.

Step 4 — Explore the CLI​

Install the CLI for scripted workflows:

curl -fsSL https://lium.io/install.sh | bash   # or `pip install lium.io`
lium --help

See the CLI installation guide for platform notes, version pinning, and the Python package alternative.

Next steps​