Create Tool | BCTRL Docs

curl -X POST https://api.bctrl.ai/v1/spaces/id/tools \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "execution": {
    "type": "webhook",
    "url": "https://hooks.example.com/api/v1/execute"
  },
  "inputSchema": {},
  "name": "data_fetcher",
  "outputSchema": {}
}'

{
  "createdAt": "2024-06-01T12:00:00Z",
  "description": "Fetches data from external API endpoints and returns structured results.",
  "enabled": true,
  "execution": {
    "auth": {
      "type": "none"
    },
    "timeoutMs": 30000,
    "type": "webhook",
    "url": "https://hooks.example.com/api/v1/execute"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inputSchema": {},
  "name": "data_fetcher",
  "outputSchema": {},
  "spaceId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
  "updatedAt": "2024-06-01T12:00:00Z",
  "metadata": {}
}

Create a custom callable capability that agents can use through toolsets. A tool defines the name, description, input and output schemas, and execution method the agent can rely on.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

executionobjectRequired

inputSchemamap from strings to anyRequired

namestringRequiredformat: "^[a-z_][a-z0-9_-]*$"1-64 characters

outputSchemamap from strings to anyRequired

descriptionstring or nullOptional<=2000 characters

enabledbooleanOptional

metadatamap from strings to any or nullOptional

Response

Default Response

createdAtstring

descriptionstring or null<=2000 characters

enabledboolean

executionobject

idstringformat: "uuid"

inputSchemamap from strings to any

namestringformat: "^[a-z_][a-z0-9_-]*$"1-64 characters

outputSchemamap from strings to any

spaceIdstringformat: "uuid"

updatedAtstring

metadatamap from strings to any or null