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

# Update Tool

PATCH https://api.bctrl.ai/v2/tools/{id}
Content-Type: application/json

Update a custom tool definition. Changes apply to future tool use while existing tool call records remain available.

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v2/tools/{id}:
    patch:
      operationId: v-2-tools-update
      summary: Update a tool
      description: >-
        Update a custom tool definition. Changes apply to future tool use while
        existing tool call records remain available.
      tags:
        - subpackage_tools
      parameters:
        - name: id
          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/tools_v2.tools.update_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type:
                    - string
                    - 'null'
                execution:
                  $ref: >-
                    #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution
                inputSchema:
                  $ref: >-
                    #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaInputSchema
                metadata:
                  oneOf:
                    - $ref: >-
                        #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaMetadata
                    - type: 'null'
                name:
                  type: string
                outputSchema:
                  $ref: >-
                    #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaOutputSchema
                spaceId:
                  type: string
                  format: uuid
                status:
                  $ref: >-
                    #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaStatus
              required:
                - spaceId
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth0:
      type: object
      properties:
        type:
          type: string
          enum:
            - none
      required:
        - type
      title: >-
        V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth0
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth1:
      type: object
      properties:
        secretId:
          type: string
        type:
          type: string
          enum:
            - hmac
      required:
        - secretId
        - type
      title: >-
        V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth1
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth0
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth1
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution0:
      type: object
      properties:
        auth:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth
        timeoutMs:
          type: integer
        type:
          type: string
          enum:
            - webhook
        url:
          type: string
          format: uri
      required:
        - type
        - url
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution0
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution1:
      type: object
      properties:
        serverId:
          type: string
        toolName:
          type: string
        type:
          type: string
          enum:
            - mcp_tool
      required:
        - serverId
        - toolName
        - type
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution1
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution2:
      type: object
      properties:
        functionId:
          type: string
        type:
          type: string
          enum:
            - hosted_function
      required:
        - functionId
        - type
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution2
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution3:
      type: object
      properties:
        type:
          type: string
          enum:
            - hosted_workflow
        workflowId:
          type: string
      required:
        - type
        - workflowId
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution3
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf4Name:
      type: string
      enum:
        - storage
        - artifacts
        - vault
        - captcha
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf4Name
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution4:
      type: object
      properties:
        name:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecutionOneOf4Name
        type:
          type: string
          enum:
            - bctrl_builtin
      required:
        - name
        - type
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution4
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution0
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution1
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution2
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution3
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution4
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaExecution
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaInputSchema:
      type: object
      properties: {}
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaInputSchema
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaMetadata:
      type: object
      properties: {}
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaMetadata
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaOutputSchema:
      type: object
      properties: {}
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaOutputSchema
    V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - enabled
        - disabled
      title: V2ToolsIdPatchRequestBodyContentApplicationJsonSchemaStatus
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0:
      type: object
      properties:
        type:
          type: string
          enum:
            - none
      required:
        - type
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1:
      type: object
      properties:
        secretId:
          type: string
        type:
          type: string
          enum:
            - hmac
      required:
        - secretId
        - type
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution0:
      type: object
      properties:
        auth:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf0Auth
        timeoutMs:
          type: integer
        type:
          type: string
          enum:
            - webhook
        url:
          type: string
          format: uri
      required:
        - type
        - url
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution0
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution1:
      type: object
      properties:
        serverId:
          type: string
        toolName:
          type: string
        type:
          type: string
          enum:
            - mcp_tool
      required:
        - serverId
        - toolName
        - type
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution1
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution2:
      type: object
      properties:
        functionId:
          type: string
        type:
          type: string
          enum:
            - hosted_function
      required:
        - functionId
        - type
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution2
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution3:
      type: object
      properties:
        type:
          type: string
          enum:
            - hosted_workflow
        workflowId:
          type: string
      required:
        - type
        - workflowId
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution3
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf4Name:
      type: string
      enum:
        - storage
        - artifacts
        - vault
        - captcha
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf4Name
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution4:
      type: object
      properties:
        name:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecutionOneOf4Name
        type:
          type: string
          enum:
            - bctrl_builtin
      required:
        - name
        - type
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution4
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution0
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution1
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution2
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution3
        - $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution4
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaInputSchema:
      type: object
      properties: {}
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaInputSchema
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaMetadata:
      type: object
      properties: {}
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaMetadata
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaOutputSchema:
      type: object
      properties: {}
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaOutputSchema
    V2ToolsIdPatchResponsesContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - enabled
        - disabled
      title: V2ToolsIdPatchResponsesContentApplicationJsonSchemaStatus
    tools_v2.tools.update_Response_200:
      type: object
      properties:
        createdAt:
          type: string
        description:
          type:
            - string
            - 'null'
        execution:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaExecution
        id:
          type: string
          format: uuid
        inputSchema:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaInputSchema
        metadata:
          oneOf:
            - $ref: >-
                #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaMetadata
            - type: 'null'
        name:
          type: string
        outputSchema:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaOutputSchema
        spaceId:
          type: string
          format: uuid
        status:
          $ref: >-
            #/components/schemas/V2ToolsIdPatchResponsesContentApplicationJsonSchemaStatus
        updatedAt:
          type: string
      required:
        - createdAt
        - description
        - execution
        - id
        - inputSchema
        - name
        - outputSchema
        - spaceId
        - status
        - updatedAt
      title: tools_v2.tools.update_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v2/tools/id"

payload = { "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v2/tools/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"spaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'
};

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/v2/tools/id"

	payload := strings.NewReader("{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")

	req, _ := http.NewRequest("PATCH", 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/v2/tools/id")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}"

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.patch("https://api.bctrl.ai/v2/tools/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.bctrl.ai/v2/tools/id', [
  'body' => '{
  "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v2/tools/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v2/tools/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```