> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For full documentation content, see https://platform.bctrl.ai/llms-full.txt.

# Get Tool

GET https://api.bctrl.ai/v1/spaces/{id}/tools/{toolId}

Get one custom tool definition, including its schemas, execution method, enabled state, and metadata. Use this to understand exactly what an agent may call.

Reference: https://platform.bctrl.ai/api/api-reference/tools/get

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/spaces/{id}/tools/{toolId}:
    get:
      operationId: tools-get
      summary: Get a tool definition in a space
      description: >-
        Get one custom tool definition, including its schemas, execution method,
        enabled state, and metadata. Use this to understand exactly what an
        agent may call.
      tags:
        - subpackage_spaces
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: toolId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/spaces_toolsGet_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0:
      type: object
      properties:
        type:
          type: string
          enum:
            - none
      required:
        - type
      title: >-
        V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1:
      type: object
      properties:
        secretId:
          type: string
        type:
          type: string
          enum:
            - hmac
      required:
        - secretId
        - type
      title: >-
        V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth:
      oneOf:
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1
      title: >-
        V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution0:
      type: object
      properties:
        auth:
          $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf0Auth
        timeoutMs:
          type: integer
        type:
          type: string
          enum:
            - webhook
        url:
          type: string
          format: uri
      required:
        - type
        - url
      title: V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution0
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution1:
      type: object
      properties:
        serverId:
          type: string
        toolName:
          type: string
        type:
          type: string
          enum:
            - mcp_tool
      required:
        - serverId
        - toolName
        - type
      title: V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution1
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution2:
      type: object
      properties:
        functionId:
          type: string
        type:
          type: string
          enum:
            - hosted_function
      required:
        - functionId
        - type
      title: V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution2
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution3:
      type: object
      properties:
        type:
          type: string
          enum:
            - hosted_workflow
        workflowId:
          type: string
      required:
        - type
        - workflowId
      title: V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution3
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf4Name:
      type: string
      enum:
        - storage
        - artifacts
        - vault
        - captcha
      title: >-
        V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf4Name
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution4:
      type: object
      properties:
        name:
          $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecutionOneOf4Name
        type:
          type: string
          enum:
            - bctrl_builtin
      required:
        - name
        - type
      title: V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution4
    V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution:
      oneOf:
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution0
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution1
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution2
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution3
        - $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution4
      title: V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution
    spaces_toolsGet_Response_200:
      type: object
      properties:
        createdAt:
          type: string
        description:
          type:
            - string
            - 'null'
        enabled:
          type: boolean
        execution:
          $ref: >-
            #/components/schemas/V1SpacesIdToolsToolIdGetResponsesContentApplicationJsonSchemaExecution
        id:
          type: string
          format: uuid
        inputSchema:
          type: object
          additionalProperties:
            description: Any type
        metadata:
          type:
            - object
            - 'null'
          additionalProperties:
            description: Any type
        name:
          type: string
        outputSchema:
          type: object
          additionalProperties:
            description: Any type
        spaceId:
          type: string
          format: uuid
        updatedAt:
          type: string
      required:
        - createdAt
        - description
        - enabled
        - execution
        - id
        - inputSchema
        - name
        - outputSchema
        - spaceId
        - updatedAt
      title: spaces_toolsGet_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/spaces/id/tools/toolId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/spaces/id/tools/toolId';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/spaces/id/tools/toolId"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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://api.bctrl.ai/v1/spaces/id/tools/toolId")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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://api.bctrl.ai/v1/spaces/id/tools/toolId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/spaces/id/tools/toolId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/spaces/id/tools/toolId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/spaces/id/tools/toolId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```