Create Tool | BCTRL Docs

curl -X POST https://api.bctrl.ai/v2/tools \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "execution": {
    "type": "webhook",
    "url": "https://hooks.bctrl.ai/tools/execute"
  },
  "inputSchema": {},
  "name": "data_fetcher",
  "outputSchema": {},
  "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

{
  "createdAt": "2024-06-01T12:00:00Z",
  "description": "Tool to fetch data from external APIs via webhook.",
  "execution": {
    "auth": {
      "type": "none"
    },
    "timeoutMs": 30000,
    "type": "webhook",
    "url": "https://hooks.bctrl.ai/tools/execute"
  },
  "id": "7e57d004-2b97-0e7a-b45f-5387367791cd",
  "inputSchema": {},
  "name": "data_fetcher",
  "outputSchema": {},
  "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "enabled",
  "updatedAt": "2024-06-01T12:00:00Z",
  "metadata": {}
}

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

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Request

This endpoint expects an object.

executionobjectRequired

inputSchemaobjectRequired

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

outputSchemaobjectRequired

spaceIdstringRequiredformat: "uuid"

descriptionstring or nullOptional<=2000 characters

metadataobject or nullOptional

statusenumOptional

Allowed values:

Response

Default Response

createdAtstring

descriptionstring or null<=2000 characters

executionobject

idstringformat: "uuid"

inputSchemaobject

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

outputSchemaobject

spaceIdstringformat: "uuid"

statusenum

Allowed values:

updatedAtstring

metadataobject or null