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

# Create Tool

POST https://api.bctrl.ai/v2/tools
Content-Type: application/json

Create a custom callable tool in a space. Agents can use these tools through toolsets during hosted work.

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v2/tools:
    post:
      operationId: v-2-tools-create
      summary: Create a tool
      description: >-
        Create a custom callable tool in a space. Agents can use these tools
        through toolsets during hosted work.
      tags:
        - subpackage_tools
      parameters:
        - 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.create_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type:
                    - string
                    - 'null'
                execution:
                  $ref: >-
                    #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution
                inputSchema:
                  $ref: >-
                    #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaInputSchema
                metadata:
                  oneOf:
                    - $ref: >-
                        #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaMetadata
                    - type: 'null'
                name:
                  type: string
                outputSchema:
                  $ref: >-
                    #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaOutputSchema
                spaceId:
                  type: string
                  format: uuid
                status:
                  $ref: >-
                    #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaStatus
              required:
                - execution
                - inputSchema
                - name
                - outputSchema
                - spaceId
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth0:
      type: object
      properties:
        type:
          type: string
          enum:
            - none
      required:
        - type
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth0
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth1:
      type: object
      properties:
        secretId:
          type: string
        type:
          type: string
          enum:
            - hmac
      required:
        - secretId
        - type
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth1
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth0
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth1
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution0:
      type: object
      properties:
        auth:
          $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf0Auth
        timeoutMs:
          type: integer
        type:
          type: string
          enum:
            - webhook
        url:
          type: string
          format: uri
      required:
        - type
        - url
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution0
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution1:
      type: object
      properties:
        serverId:
          type: string
        toolName:
          type: string
        type:
          type: string
          enum:
            - mcp_tool
      required:
        - serverId
        - toolName
        - type
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution1
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution2:
      type: object
      properties:
        functionId:
          type: string
        type:
          type: string
          enum:
            - hosted_function
      required:
        - functionId
        - type
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution2
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution3:
      type: object
      properties:
        type:
          type: string
          enum:
            - hosted_workflow
        workflowId:
          type: string
      required:
        - type
        - workflowId
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution3
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf4Name:
      type: string
      enum:
        - storage
        - artifacts
        - vault
        - captcha
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf4Name
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution4:
      type: object
      properties:
        name:
          $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecutionOneOf4Name
        type:
          type: string
          enum:
            - bctrl_builtin
      required:
        - name
        - type
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution4
    V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution0
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution1
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution2
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution3
        - $ref: >-
            #/components/schemas/V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution4
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaExecution
    V2ToolsPostRequestBodyContentApplicationJsonSchemaInputSchema:
      type: object
      properties: {}
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaInputSchema
    V2ToolsPostRequestBodyContentApplicationJsonSchemaMetadata:
      type: object
      properties: {}
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaMetadata
    V2ToolsPostRequestBodyContentApplicationJsonSchemaOutputSchema:
      type: object
      properties: {}
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaOutputSchema
    V2ToolsPostRequestBodyContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - enabled
        - disabled
      title: V2ToolsPostRequestBodyContentApplicationJsonSchemaStatus
    V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0:
      type: object
      properties:
        type:
          type: string
          enum:
            - none
      required:
        - type
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0
    V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1:
      type: object
      properties:
        secretId:
          type: string
        type:
          type: string
          enum:
            - hmac
      required:
        - secretId
        - type
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1
    V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth0
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth1
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth
    V2ToolsPostResponsesContentApplicationJsonSchemaExecution0:
      type: object
      properties:
        auth:
          $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf0Auth
        timeoutMs:
          type: integer
        type:
          type: string
          enum:
            - webhook
        url:
          type: string
          format: uri
      required:
        - type
        - url
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecution0
    V2ToolsPostResponsesContentApplicationJsonSchemaExecution1:
      type: object
      properties:
        serverId:
          type: string
        toolName:
          type: string
        type:
          type: string
          enum:
            - mcp_tool
      required:
        - serverId
        - toolName
        - type
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecution1
    V2ToolsPostResponsesContentApplicationJsonSchemaExecution2:
      type: object
      properties:
        functionId:
          type: string
        type:
          type: string
          enum:
            - hosted_function
      required:
        - functionId
        - type
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecution2
    V2ToolsPostResponsesContentApplicationJsonSchemaExecution3:
      type: object
      properties:
        type:
          type: string
          enum:
            - hosted_workflow
        workflowId:
          type: string
      required:
        - type
        - workflowId
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecution3
    V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf4Name:
      type: string
      enum:
        - storage
        - artifacts
        - vault
        - captcha
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf4Name
    V2ToolsPostResponsesContentApplicationJsonSchemaExecution4:
      type: object
      properties:
        name:
          $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecutionOneOf4Name
        type:
          type: string
          enum:
            - bctrl_builtin
      required:
        - name
        - type
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecution4
    V2ToolsPostResponsesContentApplicationJsonSchemaExecution:
      oneOf:
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecution0
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecution1
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecution2
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecution3
        - $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecution4
      title: V2ToolsPostResponsesContentApplicationJsonSchemaExecution
    V2ToolsPostResponsesContentApplicationJsonSchemaInputSchema:
      type: object
      properties: {}
      title: V2ToolsPostResponsesContentApplicationJsonSchemaInputSchema
    V2ToolsPostResponsesContentApplicationJsonSchemaMetadata:
      type: object
      properties: {}
      title: V2ToolsPostResponsesContentApplicationJsonSchemaMetadata
    V2ToolsPostResponsesContentApplicationJsonSchemaOutputSchema:
      type: object
      properties: {}
      title: V2ToolsPostResponsesContentApplicationJsonSchemaOutputSchema
    V2ToolsPostResponsesContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - enabled
        - disabled
      title: V2ToolsPostResponsesContentApplicationJsonSchemaStatus
    tools_v2.tools.create_Response_200:
      type: object
      properties:
        createdAt:
          type: string
        description:
          type:
            - string
            - 'null'
        execution:
          $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaExecution
        id:
          type: string
          format: uuid
        inputSchema:
          $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaInputSchema
        metadata:
          oneOf:
            - $ref: >-
                #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaMetadata
            - type: 'null'
        name:
          type: string
        outputSchema:
          $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaOutputSchema
        spaceId:
          type: string
          format: uuid
        status:
          $ref: >-
            #/components/schemas/V2ToolsPostResponsesContentApplicationJsonSchemaStatus
        updatedAt:
          type: string
      required:
        - createdAt
        - description
        - execution
        - id
        - inputSchema
        - name
        - outputSchema
        - spaceId
        - status
        - updatedAt
      title: tools_v2.tools.create_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"

payload = {
    "execution": {
        "type": "webhook",
        "url": "https://hooks.bctrl.ai/tools/execute"
    },
    "name": "data_fetcher",
    "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v2/tools';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"execution":{"type":"webhook","url":"https://hooks.bctrl.ai/tools/execute"},"name":"data_fetcher","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"

	payload := strings.NewReader("{\n  \"execution\": {\n    \"type\": \"webhook\",\n    \"url\": \"https://hooks.bctrl.ai/tools/execute\"\n  },\n  \"name\": \"data_fetcher\",\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")

	req, _ := http.NewRequest("POST", 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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"execution\": {\n    \"type\": \"webhook\",\n    \"url\": \"https://hooks.bctrl.ai/tools/execute\"\n  },\n  \"name\": \"data_fetcher\",\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.post("https://api.bctrl.ai/v2/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"execution\": {\n    \"type\": \"webhook\",\n    \"url\": \"https://hooks.bctrl.ai/tools/execute\"\n  },\n  \"name\": \"data_fetcher\",\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v2/tools', [
  'body' => '{
  "execution": {
    "type": "webhook",
    "url": "https://hooks.bctrl.ai/tools/execute"
  },
  "name": "data_fetcher",
  "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");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"execution\": {\n    \"type\": \"webhook\",\n    \"url\": \"https://hooks.bctrl.ai/tools/execute\"\n  },\n  \"name\": \"data_fetcher\",\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 = [
  "execution": [
    "type": "webhook",
    "url": "https://hooks.bctrl.ai/tools/execute"
  ],
  "name": "data_fetcher",
  "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")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```