> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.lumenia.net/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.lumenia.net/_mcp/server. # Get effective workspace tools GET https://app.lumenia.net/api/v1/workspaces/{workspaceId}/tools/effective Return the tools available to each workspace channel. Reference: https://docs.lumenia.net/api-reference/workspace-tools/get-effective-workspace-tools ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where `API_KEY` is your API key. ## Request ### Path parameters - `workspaceId` (string, required) — Workspace whose available tools to return. ### Query parameters - `mode` (string, optional) — Return only this channel instead of both. ### Headers - `X-Account-Id` (string, required) — Account that owns the workspace. ## Response ### 200 Available tools by channel. Returns only the requested channel when mode is set. - `chat` (V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaChat, optional) — The effective tool set of the chat channel. - `voice` (V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaVoice, optional) — The effective tool set of the voice channel. Same shape as chat. ## Errors ### 400 Bad Request Error Invalid mode (must be chat or voice) - `any` ### 403 Forbidden Error The API key is missing or invalid, or the X-Account-Id does not belong to the partner. - `message` (string, optional) ### 404 Not Found Error Workspace not found for this account - `any` ### 500 Internal Server Error Internal Server Error - `any` ## Types ### V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaChat The effective tool set of the chat channel. - `tools` (list of V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaChatToolsItems, optional) — Tools available to chat. When names conflict, direct organization tools take priority, then direct partner tools, then template tools. - `shadowed` (list of V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaChatShadowedItems, optional) — Tools excluded because their names conflict with a higher-priority tool. ### V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaVoice The effective tool set of the voice channel. Same shape as chat. - `tools` (list of V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaVoiceToolsItems, optional) - `shadowed` (list of V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaVoiceShadowedItems, optional) ### V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaChatToolsItems - `id` (string, optional) — The tool id. - `name` (string, optional) — The tool name the assistant calls it by. - `description` (string, optional, nullable) — Human-readable description of what the tool does. - `method` (string, optional) — HTTP method the tool uses to call its endpoint. - `url` (string, optional) — The endpoint the tool calls. - `createdAt` (string, optional) — ISO 8601 timestamp of when the tool was created. - `updatedAt` (string, optional) — ISO 8601 timestamp of when the tool was last updated. - `source` (enum, optional) — How the tool reached this workspace: direct attachment, or brought in by the pinned prompt template version. - Allowed values: `direct`, `template` - `scope` (enum, optional) — Who owns the tool definition. - Allowed values: `organization`, `partner` ### V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaChatShadowedItems - `id` (string, optional) — The shadowed tool id. - `name` (string, optional) — The name that conflicts with a higher-priority tool. - `source` (enum, optional) — How the shadowed tool reached this workspace. - Allowed values: `direct`, `template` - `scope` (enum, optional) — Who owns the shadowed tool. - Allowed values: `organization`, `partner` - `overriddenBy` (string, optional) — The id of the tool that won the collision. ### V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaVoiceToolsItems ### V1WorkspacesWorkspaceIdToolsEffectiveGetResponsesContentApplicationJsonSchemaVoiceShadowedItems ## Examples **Response** ```json { "chat": { "tools": [ { "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d", "name": "Create ticket", "description": "Open a support ticket", "method": "POST", "url": "https://api.example.com/tickets", "createdAt": "2026-06-15T05:24:00.000Z", "updatedAt": "2026-06-15T05:24:00.000Z", "source": "direct", "scope": "organization" } ], "shadowed": [] }, "voice": { "tools": [ { "createdAt": "2026-06-15T05:24:00.000Z", "description": "Open a support ticket", "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d", "method": "POST", "name": "Create ticket", "scope": "organization", "source": "direct", "updatedAt": "2026-06-15T05:24:00.000Z", "url": "https://api.example.com/tickets" }, { "createdAt": "2026-06-20T05:24:00.000Z", "description": "Look up an order", "id": "d4e5f6a7-8091-4c3d-ae4f-5a6b7c8d9e0f", "method": "GET", "name": "get_order_status", "scope": "partner", "source": "template", "updatedAt": "2026-06-20T05:24:00.000Z", "url": "https://api.partner.example/orders/status" } ], "shadowed": [ { "createdAt": "2026-06-20T05:24:00.000Z", "description": "Template variant", "id": "c3d4e5f6-7081-4b2c-9d3e-4f5a6b7c8d9e", "method": "POST", "name": "create ticket", "overriddenBy": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d", "scope": "partner", "source": "template", "updatedAt": "2026-06-20T05:24:00.000Z", "url": "https://api.partner.example/tickets" } ] } } ``` **SDK Code** ```python import requests url = "https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective" headers = { "X-Account-Id": "X-Account-Id", "Authorization": "Bearer " } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective'; const options = { method: 'GET', headers: {'X-Account-Id': 'X-Account-Id', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Id", "X-Account-Id") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Id"] = 'X-Account-Id' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective") .header("X-Account-Id", "X-Account-Id") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Id' => 'X-Account-Id', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Id", "X-Account-Id"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Id": "X-Account-Id", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://app.lumenia.net/api/v1/workspaces/workspaceId/tools/effective")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```