> 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 tool

GET https://app.lumenia.net/api/v1/tools/{toolId}

Return a tool by ID.

Reference: https://docs.lumenia.net/api-reference/tools/get-tool

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <API_KEY>`, where `API_KEY` is your API key.

## Request

### Path parameters

- `toolId` (string, required) — Tool to retrieve.

### Query parameters

- `unmask` (string, optional) — Comma-separated header names to reveal. Other header values remain masked.

### Headers

- `X-Account-Id` (string, optional) — Send this to address an organization tool. Omit it to address a partner tool.

## Response

### 200

The requested tool.

- `tool` (V1ToolsToolIdGetResponsesContentApplicationJsonSchemaTool, required) — The tool.

## Errors

### 403 Forbidden Error

The API key is missing or invalid, or the X-Account-Id (when sent) does not belong to the API key partner.

- `message` (string, optional)

### 404 Not Found Error

No tool with this id exists in the addressed scope (also returned when the id is not a valid uuid).

- `any`

### 500 Internal Server Error

Internal Server Error

- `any`

## Types

### V1ToolsToolIdGetResponsesContentApplicationJsonSchemaTool

The tool.

- `id` (string, optional) — The sole identifier for the tool.
- `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.
- `headers` (V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolHeaders, optional) — HTTP headers sent with the request. Values are fully masked by default (shown as ••••••), whether or not they are secret; reveal specific ones with the unmask query parameter.
- `requestSchema` (V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolRequestSchema, optional, nullable) — JSON Schema of the payload the tool sends. Returned as-is.
- `responseSchema` (V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolResponseSchema, optional, nullable) — JSON Schema of the fields to extract from the tool HTTP JSON response. Returned as-is.
- `aliases` (list of V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolAliasesItems, optional) — Variable bindings evaluated over the parsed JSON response, where the response body is the $ root (e.g. $.data.id), with top-level response properties also spread at the root. Each entry maps a variable key to a Liquid template.
- `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.

### V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolHeaders

HTTP headers sent with the request. Values are fully masked by default (shown as ••••••), whether or not they are secret; reveal specific ones with the unmask query parameter.

### V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolRequestSchema

JSON Schema of the payload the tool sends. Returned as-is.

### V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolResponseSchema

JSON Schema of the fields to extract from the tool HTTP JSON response. Returned as-is.

### V1ToolsToolIdGetResponsesContentApplicationJsonSchemaToolAliasesItems

- `key` (string, optional) — The variable name the bound value is exposed as.
- `value` (string, optional) — Liquid template evaluated over the response body.

## Examples

**Response**

```json
{
  "tool": {
    "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
    "name": "ask_lumenone",
    "description": "Query the knowledge base",
    "method": "POST",
    "url": "https://app.lumenia.tech/api/v1/vapi/ask_lumenone",
    "headers": {
      "properties": {
        "Authorization": {
          "type": "string",
          "value": "••••••"
        }
      },
      "type": "object"
    },
    "requestSchema": {
      "properties": {
        "query": {
          "description": "The caller question",
          "type": "string"
        }
      },
      "required": [
        "query"
      ],
      "type": "object"
    },
    "responseSchema": {
      "properties": {
        "answer": {
          "description": "Answer to read back to the caller",
          "type": "string"
        }
      },
      "required": [
        "answer"
      ],
      "type": "object"
    },
    "aliases": [
      {
        "key": "kb_answer",
        "value": "{{ $.answer }}"
      }
    ],
    "createdAt": "2026-06-15T05:24:00.000Z",
    "updatedAt": "2026-06-15T05:24:00.000Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.lumenia.net/api/v1/tools/toolId"

headers = {"Authorization": "Bearer <API_KEY>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.lumenia.net/api/v1/tools/toolId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

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/tools/toolId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <API_KEY>")

	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/tools/toolId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <API_KEY>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.lumenia.net/api/v1/tools/toolId")
  .header("Authorization", "Bearer <API_KEY>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.lumenia.net/api/v1/tools/toolId', [
  'headers' => [
    'Authorization' => 'Bearer <API_KEY>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.lumenia.net/api/v1/tools/toolId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <API_KEY>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <API_KEY>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.lumenia.net/api/v1/tools/toolId")! 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()
```