Skip to content

Workspace API

The Workspace API returns all the data a client needs to initialize: the current model, installed apps, recent conversations, and system status. Use it as a single request to bootstrap a UI or integration.

Fetch the workspace bootstrap payload. This endpoint aggregates data from multiple internal sources into a single response to minimize round-trips.

Response:

{
"model": "claude-sonnet-4-5-20250929",
"apps": [
{
"name": "bash",
"bundleName": "@nimblebraininc/bash",
"version": "0.2.0",
"status": "running",
"type": "plain",
"toolCount": 1,
"trustScore": 95,
"ui": null
},
{
"name": "tasks",
"bundleName": "@nimblebraininc/tasks",
"version": "1.0.0",
"status": "running",
"type": "upjack",
"toolCount": 5,
"trustScore": 92,
"ui": {
"name": "Tasks",
"icon": "check-square",
"primaryView": { "resourceUri": "ui://tasks/board" }
}
}
],
"recentConversations": [
{
"id": "conv_a1b2c3d4",
"createdAt": "2025-10-15T10:30:00.000Z",
"updatedAt": "2025-10-15T11:45:00.000Z",
"title": "Weather analysis for Q4",
"messageCount": 12,
"preview": "Can you analyze the weather patterns for...",
"totalInputTokens": 15420,
"totalOutputTokens": 3200,
"totalCostUsd": 0.058
}
],
"status": {
"uptime": 3600,
"totalTools": 14
},
"installId": "anon_x1y2z3",
"telemetryEnabled": true
}

Response fields:

FieldTypeDescription
modelstringDefault model ID configured for the workspace
appsAppInfo[]All installed apps (same shape as GET /v1/apps)
recentConversationsConversationSummary[]Up to 20 most recent conversations
status.uptimenumberServer uptime in seconds
status.totalToolsnumberTotal tools available across all installed apps
installIdstring?Anonymous telemetry ID. Only present when telemetry is enabled.
telemetryEnabledboolean?Whether anonymous telemetry is active. Only present when enabled.

Example:

Terminal window
curl http://localhost:27247/v1/workspace \
-H "Authorization: Bearer your-secret-key"