Get workspace

GET

https://app.lumenia.net/api/v1/workspaces/:workspaceId

GET

/api/v1/workspaces/:workspaceId

$ curl https://app.lumenia.net/api/v1/workspaces/workspaceId \
>      -H "X-Account-Id: X-Account-Id" \
>      -H "Authorization: Bearer <API_KEY>"

1 {
2   "workspace": {
3     "id": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
4     "organizationId": "3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f",
5     "name": "Support",
6     "createdAt": "2026-06-15T05:24:00.000Z",
7     "chat": {
8       "mode": "chat",
9       "prompt": "Given the following conversation...",
10       "historyLimit": 20,
11       "temperature": null
12     },
13     "knowledgeSearch": {
14       "topResults": 4,
15       "similarityThreshold": 0.25,
16       "queryRefusalMessage": "There is no relevant information in this workspace to answer your query."
17     },
18     "branding": {
19       "background": "#ffd940",
20       "foreground": "#1a1a1a",
21       "logo": "https://your-host/api/v1/workspaces/9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d/logo?v=2f1c...png"
22     },
23     "voice": {
24       "connected": true,
25       "promptSource": "manual",
26       "promptTemplate": null,
27       "firstMessage": "Hello! How can I help you today?",
28       "prompt": "You are a friendly phone assistant. Keep responses concise and helpful.",
29       "voice": {
30         "provider": "vapi",
31         "voiceId": "Clara",
32         "model": null
33       },
34       "fallbackVoices": [],
35       "transcriber": {
36         "provider": "deepgram",
37         "model": "flux-general-en",
38         "language": "en"
39       },
40       "fallbackTranscribers": [],
41       "phoneNumber": "+3907751671041"
42     },
43     "whatsapp": {
44       "connected": true,
45       "phoneNumberId": "123456789",
46       "businessAccountId": "987654321",
47       "businessId": "5551234"
48     },
49     "telegram": {
50       "connected": false
51     },
52     "counts": {
53       "embeddedDocuments": 12,
54       "attachedTools": 3
55     }
56   }
57 }

Return a workspace by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <API_KEY>, where API_KEY is your API key.

Path parameters

workspaceIdstringRequired

Workspace to retrieve.

Query parameters

includeRenderedbooleanOptional

Include rendered prompt text and first messages in prompt-template assignments.

Response

The requested workspace, including configuration and integration status.

workspaceobjectOptional

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors