Get Tool | BCTRL Docs

{
  "type": "webhook",
  "createdAt": "2024-05-20T10:15:30Z",
  "description": "Webhook tool for processing incoming payment notifications and updating order status.",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inputSchema": {
    "type": "object",
    "properties": {
      "paymentId": {
        "type": "string",
        "description": "Unique identifier for the payment transaction"
      },
      "amount": {
        "type": "number",
        "description": "Amount paid in USD"
      },
      "currency": {
        "type": "string",
        "description": "Currency code, e.g. USD"
      }
    },
    "required": [
      "paymentId",
      "amount",
      "currency"
    ]
  },
  "name": "payment_webhook",
  "outputSchema": {
    "type": "object",
    "properties": {
      "orderId": {
        "type": "string",
        "description": "Identifier of the order updated"
      },
      "status": {
        "type": "string",
        "enum": [
          "success",
          "failure"
        ],
        "description": "Result of the webhook processing"
      }
    },
    "required": [
      "orderId",
      "status"
    ]
  },
  "spaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "status": "enabled",
  "updatedAt": "2024-05-22T08:45:00Z",
  "url": "https://hooks.bctrl.ai/payment-notify",
  "authSecretId": "authsec_9f8b7c6d5e4a3b2c1d0e",
  "metadata": {
    "version": "1.2.0",
    "owner": "finance-team",
    "lastReviewed": "2024-05-15"
  },
  "timeoutMs": 30000
}

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

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Response

builtinobject

hostedobject

mcpobject

webhookobject

workflowobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl https://api.bctrl.ai/v1/tools/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"