Get effective workspace tools

GET

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

GET

/api/v1/workspaces/:workspaceId/tools/effective

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

1 {
2   "chat": {
3     "tools": [
4       {
5         "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
6         "name": "Create ticket",
7         "description": "Open a support ticket",
8         "method": "POST",
9         "url": "https://api.example.com/tickets",
10         "createdAt": "2026-06-15T05:24:00.000Z",
11         "updatedAt": "2026-06-15T05:24:00.000Z",
12         "source": "direct",
13         "scope": "organization"
14       }
15     ],
16     "shadowed": []
17   },
18   "voice": {
19     "tools": [
20       {
21         "createdAt": "2026-06-15T05:24:00.000Z",
22         "description": "Open a support ticket",
23         "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
24         "method": "POST",
25         "name": "Create ticket",
26         "scope": "organization",
27         "source": "direct",
28         "updatedAt": "2026-06-15T05:24:00.000Z",
29         "url": "https://api.example.com/tickets"
30       },
31       {
32         "createdAt": "2026-06-20T05:24:00.000Z",
33         "description": "Look up an order",
34         "id": "d4e5f6a7-8091-4c3d-ae4f-5a6b7c8d9e0f",
35         "method": "GET",
36         "name": "get_order_status",
37         "scope": "partner",
38         "source": "template",
39         "updatedAt": "2026-06-20T05:24:00.000Z",
40         "url": "https://api.partner.example/orders/status"
41       }
42     ],
43     "shadowed": [
44       {
45         "createdAt": "2026-06-20T05:24:00.000Z",
46         "description": "Template variant",
47         "id": "c3d4e5f6-7081-4b2c-9d3e-4f5a6b7c8d9e",
48         "method": "POST",
49         "name": "create ticket",
50         "overriddenBy": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
51         "scope": "partner",
52         "source": "template",
53         "updatedAt": "2026-06-20T05:24:00.000Z",
54         "url": "https://api.partner.example/tickets"
55       }
56     ]
57   }
58 }

Return the tools available to each workspace channel.

Authentication

AuthorizationBearer

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

Path parameters

workspaceIdstringRequired

Workspace whose available tools to return.

Query parameters

modestringOptional

Return only this channel instead of both.

Response

Available tools by channel. Returns only the requested channel when mode is set.

chatobjectOptional

The effective tool set of the chat channel.

voiceobjectOptional

The effective tool set of the voice channel. Same shape as chat.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors