> 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 AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server.

# Update a tool

PATCH https://api.bctrl.ai/v1/tools/{toolRef}
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

## Authentication

- `Authorization` header (bearer token, required) — Use Bearer \<api-key>.

## Servers

- `https://api.bctrl.ai` (Production, default)
- `http://localhost:8787` (Local development gateway)

## Request

### Path parameters

- `toolRef` (string, required)

### Headers

- `BCTRL-Subaccount-Id` (string, optional) — Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

### Body (application/json)

- `currentRevisionId` (string, required) — Unique toolRevision identifier generated by BCTRL.
- `description` (string, optional)
- `implementation` (object or object, optional)
  - object
    - `source` (string, required)
    - `type` ("code", required)
    - `language` ("typescript", optional, default: typescript)
    - `timeoutMs` (integer, optional, default: 30000)
  - object
    - `type` ("webhook", required)
    - `url` (string, required)
    - `authSecretName` (string, optional, nullable)
    - `timeoutMs` (integer, optional, default: 30000)
- `inputSchema` (object, optional)
- `modes` (list of enum, optional)
  - Allowed values: `sync`, `async`
- `outputSchema` (object, optional)
- `runtimeTypes` (list of enum, optional)
  - Allowed values: `browser`, `desktop`, `spreadsheet`

## Response

### 200

OK

- `object or object`
  - BuiltinTool
    - `currentRevisionId` (any, required)
    - `description` (string, required)
    - `id` (enum, required)
      - Allowed values: `stagehand.act`, `stagehand.observe`, `stagehand.extract`, `captcha.solve`, `human.request`, `browser.pages.list`, `browser.pages.open`, `browser.pages.get`, `browser.pages.activate`, `browser.pages.close`, `runtime.files.list`, `runtime.files.stage`, `runtime.files.collect`, `run.files.export`, `files.list`, `files.read_text`, `vault.secrets.list`, `vault.secrets.get`, `vault.secrets.set`, `vault.secrets.update`, `vault.secrets.delete`, `vault.secrets.value`, `vault.totp.generate`, `code.execute`
    - `implementation` (object, required)
      - `name` (enum, required)
        - Allowed values: `stagehand.act`, `stagehand.observe`, `stagehand.extract`, `captcha.solve`, `human.request`, `browser.pages.list`, `browser.pages.open`, `browser.pages.get`, `browser.pages.activate`, `browser.pages.close`, `runtime.files.list`, `runtime.files.stage`, `runtime.files.collect`, `run.files.export`, `files.list`, `files.read_text`, `vault.secrets.list`, `vault.secrets.get`, `vault.secrets.set`, `vault.secrets.update`, `vault.secrets.delete`, `vault.secrets.value`, `vault.totp.generate`, `code.execute`
      - `type` ("builtin", required)
    - `inputSchema` (object, required)
    - `modes` (list of enum, required)
      - Allowed values: `sync`, `async`
    - `name` (enum, required)
      - Allowed values: `stagehand.act`, `stagehand.observe`, `stagehand.extract`, `captcha.solve`, `human.request`, `browser.pages.list`, `browser.pages.open`, `browser.pages.get`, `browser.pages.activate`, `browser.pages.close`, `runtime.files.list`, `runtime.files.stage`, `runtime.files.collect`, `run.files.export`, `files.list`, `files.read_text`, `vault.secrets.list`, `vault.secrets.get`, `vault.secrets.set`, `vault.secrets.update`, `vault.secrets.delete`, `vault.secrets.value`, `vault.totp.generate`, `code.execute`
    - `outputSchema` (object, required)
    - `runtimeTypes` (list of enum, required)
      - Allowed values: `browser`, `desktop`, `spreadsheet`
    - `spaceId` (any, required)
  - CustomTool
    - `createdAt` (datetime, required) — RFC 3339 timestamp with a UTC offset.
    - `currentRevisionId` (string, required) — Unique toolRevision identifier generated by BCTRL.
    - `description` (string, required)
    - `id` (string, required) — Unique tool identifier generated by BCTRL.
    - `implementation` (object or object or object, required)
      - object
        - `language` ("typescript", required)
        - `timeoutMs` (integer, required)
        - `type` ("code", required)
      - object
        - `authSecretName` (string, required, nullable)
        - `timeoutMs` (integer, required)
        - `type` ("webhook", required)
        - `url` (string, required)
      - object
        - `type` ("workflow", required)
        - `versionId` (string, required)
        - `workflowId` (string, required)
    - `inputSchema` (object, required)
    - `modes` (list of enum, required)
      - Allowed values: `sync`, `async`
    - `name` (string, required)
    - `outputSchema` (object, required)
    - `runtimeTypes` (list of enum, required)
      - Allowed values: `browser`, `desktop`, `spreadsheet`
    - `spaceId` (string, required) — Unique space identifier generated by BCTRL.
    - `updatedAt` (datetime, required) — RFC 3339 timestamp with a UTC offset.

## Examples

**Request**

```json
{
  "currentRevisionId": "string"
}
```

**Response**

```json
{
  "currentRevisionId": null,
  "description": "string",
  "id": "stagehand.act",
  "implementation": {
    "name": "stagehand.act",
    "type": "string"
  },
  "inputSchema": {},
  "modes": [
    "sync"
  ],
  "name": "stagehand.act",
  "outputSchema": {},
  "runtimeTypes": [
    "browser"
  ],
  "spaceId": null
}
```

**SDK Code**

```python
import requests

url = "https://api.bctrl.ai/v1/tools/toolRef"

payload = { "currentRevisionId": "string" }
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/v1/tools/toolRef';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"currentRevisionId":"string"}'
};

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

	payload := strings.NewReader("{\n  \"currentRevisionId\": \"string\"\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/v1/tools/toolRef")

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  \"currentRevisionId\": \"string\"\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/v1/tools/toolRef")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currentRevisionId\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.bctrl.ai/v1/tools/toolRef', [
  'body' => '{
  "currentRevisionId": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

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

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/tools/toolRef")! 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()
```