Get Tool | BCTRL Docs

curl -G https://api.bctrl.ai/v2/tools/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d spaceId=spaceId

{
  "createdAt": "2024-06-01T12:00:00Z",
  "description": "A webhook tool to process incoming data and trigger workflows.",
  "execution": {
    "auth": {
      "type": "hmac",
      "secretId": "secret_123456789abcdef"
    },
    "timeoutMs": 30000,
    "type": "webhook",
    "url": "https://hooks.bctrl.ai/process"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inputSchema": {
    "type": "object",
    "properties": {
      "userId": {
        "type": "string",
        "description": "Unique identifier for the user"
      },
      "payload": {
        "type": "object",
        "description": "Data payload to be processed"
      }
    },
    "required": [
      "userId",
      "payload"
    ]
  },
  "name": "data_processor",
  "outputSchema": {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "enum": [
          "success",
          "failure"
        ]
      },
      "processedAt": {
        "type": "string",
        "format": "date-time"
      }
    },
    "required": [
      "status",
      "processedAt"
    ]
  },
  "spaceId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "status": "enabled",
  "updatedAt": "2024-06-10T08:30:00Z",
  "metadata": {
    "createdBy": "admin_user",
    "version": "1.2.0",
    "tags": [
      "webhook",
      "integration"
    ]
  }
}

Get one custom tool definition, including its schemas, execution method, status, and metadata.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Query parameters

spaceIdstringRequiredformat: "uuid"

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