API Reference
Images
Browse the catalog of base images available for creating workspaces. Images come pre-configured with operating systems, runtimes, and databases.
List images
Search and browse available images.
// All images
const all = await ws.images.list();
// Search by keyword
const nodeImages = await ws.images.list({ search: 'node' });
// Filter by category
const databases = await ws.images.list({ category: 'database' });GET /workspace/images?search=node&category=runtime# All images
curl "https://api.oblien.com/workspace/images" \
-H "X-Client-ID: $OBLIEN_CLIENT_ID" \
-H "X-Client-Secret: $OBLIEN_CLIENT_SECRET"
# Search
curl "https://api.oblien.com/workspace/images?search=python" \
-H "X-Client-ID: $OBLIEN_CLIENT_ID" \
-H "X-Client-Secret: $OBLIEN_CLIENT_SECRET"
# By category
curl "https://api.oblien.com/workspace/images?category=database" \
-H "X-Client-ID: $OBLIEN_CLIENT_ID" \
-H "X-Client-Secret: $OBLIEN_CLIENT_SECRET"Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | - | Partial match on image ID, label, or description |
category | string | "all" | "all", "os", "runtime", or "database" |
This endpoint does not require workspace ownership. Any authenticated user can browse images.
Response
{
"success": true,
"images": [
{
"id": "node-20",
"label": "Node.js 20",
"description": "Node.js 20 LTS on Ubuntu",
"category": "runtime"
},
{
"id": "ubuntu-24",
"label": "Ubuntu 24.04",
"description": "Ubuntu 24.04 LTS",
"category": "os"
}
],
"categories": ["os", "runtime", "database"]
}Available images
The image catalog is dynamic and continually expanding. Use the API to browse all available images. Categories include os, runtime, database, agent, framework, vector, browser, infra, and devtools.
See Concepts: Images for guidance on choosing the right image and a full category overview.