Create tool

curl --request POST \
  --url https://app.sulus.ai/api/tools \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Check Order Status",
  "type": "apiRequest",
  "description": "Looks up an order by ID and returns its current status.",
  "server": {
    "url": "https://api.example-business.com/orders/lookup",
    "method": "POST",
    "timeoutSeconds": 20,
    "headers": [{"key": "X-Api-Key", "value": "{{env.ORDERS_API_KEY}}"}],
    "bodyProperties": [
      {"name": "orderId", "type": "string", "description": "The order confirmation number", "required": true}
    ],
    "staticFields": [{"key": "source", "type": "string", "value": "voice-assistant"}],
    "lockSchema": false,
    "encryptedFields": ["X-Api-Key"],
    "backoffPlan": {"type": "exponential", "maxRetries": 3, "baseDelaySeconds": 2, "excludedStatusCodes": [400, 404]},
    "credentialId": "3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b"
  },
  "variableExtractionPlan": {
    "properties": [
      {"name": "orderStatus", "type": "string", "description": "Current status of the order", "required": false}
    ],
    "aliases": [{"key": "status", "value": "orderStatus"}]
  },
  "rejectionPlan": {
    "conditions": [{"type": "regex", "value": "^(cancelled|refunded)$"}]
  },
  "messages": [
    {"type": "request-start", "mode": "custom", "content": "Let me check on that order for you."},
    {"type": "request-failed", "mode": "custom", "content": "I'\''m having trouble reaching our order system right now."}
  ],
  "async": false,
  "metadata": {"category": "orders"}
}'

import requests

url = "https://app.sulus.ai/api/tools"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}
payload = {
  "name": "Check Order Status",
  "type": "apiRequest",
  "description": "Looks up an order by ID and returns its current status.",
  "server": {
    "url": "https://api.example-business.com/orders/lookup",
    "method": "POST",
    "timeoutSeconds": 20,
    "headers": [{"key": "X-Api-Key", "value": "{{env.ORDERS_API_KEY}}"}],
    "bodyProperties": [
      {"name": "orderId", "type": "string", "description": "The order confirmation number", "required": true}
    ],
    "staticFields": [{"key": "source", "type": "string", "value": "voice-assistant"}],
    "lockSchema": false,
    "encryptedFields": ["X-Api-Key"],
    "backoffPlan": {"type": "exponential", "maxRetries": 3, "baseDelaySeconds": 2, "excludedStatusCodes": [400, 404]},
    "credentialId": "3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b"
  },
  "variableExtractionPlan": {
    "properties": [
      {"name": "orderStatus", "type": "string", "description": "Current status of the order", "required": false}
    ],
    "aliases": [{"key": "status", "value": "orderStatus"}]
  },
  "rejectionPlan": {
    "conditions": [{"type": "regex", "value": "^(cancelled|refunded)$"}]
  },
  "messages": [
    {"type": "request-start", "mode": "custom", "content": "Let me check on that order for you."},
    {"type": "request-failed", "mode": "custom", "content": "I'm having trouble reaching our order system right now."}
  ],
  "async": false,
  "metadata": {"category": "orders"}
}

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

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	url := "https://app.sulus.ai/api/tools"
	payload := strings.NewReader(`{
  "name": "Check Order Status",
  "type": "apiRequest",
  "description": "Looks up an order by ID and returns its current status.",
  "server": {
    "url": "https://api.example-business.com/orders/lookup",
    "method": "POST",
    "timeoutSeconds": 20,
    "headers": [{"key": "X-Api-Key", "value": "{{env.ORDERS_API_KEY}}"}],
    "bodyProperties": [
      {"name": "orderId", "type": "string", "description": "The order confirmation number", "required": true}
    ],
    "staticFields": [{"key": "source", "type": "string", "value": "voice-assistant"}],
    "lockSchema": false,
    "encryptedFields": ["X-Api-Key"],
    "backoffPlan": {"type": "exponential", "maxRetries": 3, "baseDelaySeconds": 2, "excludedStatusCodes": [400, 404]},
    "credentialId": "3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b"
  },
  "variableExtractionPlan": {
    "properties": [
      {"name": "orderStatus", "type": "string", "description": "Current status of the order", "required": false}
    ],
    "aliases": [{"key": "status", "value": "orderStatus"}]
  },
  "rejectionPlan": {
    "conditions": [{"type": "regex", "value": "^(cancelled|refunded)$"}]
  },
  "messages": [
    {"type": "request-start", "mode": "custom", "content": "Let me check on that order for you."},
    {"type": "request-failed", "mode": "custom", "content": "I'm having trouble reaching our order system right now."}
  ],
  "async": false,
  "metadata": {"category": "orders"}
}`)
	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
	req.Header.Add("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

{
    "success": true,
    "data": {
        "name": "Check Order Status",
        "user_id": 42,
        "external_tool_id": "d4e5f6a7-8b9c-4a1d-9e2f-3a4b5c6d7e8f",
        "status": "published",
        "created_by": 42,
        "reseller_id": "f1e2d3c4-b5a6-4978-8901-234567890abc",
        "workspace_id": "9a8b7c6d-5e4f-4a3b-9c8d-7e6f5a4b3c2d",
        "type": "apiRequest",
        "description": "Looks up an order by ID and returns its current status.",
        "function_def": {
            "name": "check_order_status"
        },
        "server": {
            "url": "https://api.example-business.com/orders/lookup",
            "method": "POST",
            "timeoutSeconds": 20,
            "headers": [
                {
                    "key": "X-Api-Key",
                    "value": "{{env.ORDERS_API_KEY}}"
                }
            ],
            "bodyProperties": [
                {
                    "name": "orderId",
                    "type": "string",
                    "required": true,
                    "description": "The order confirmation number"
                }
            ],
            "staticFields": [
                {
                    "key": "source",
                    "type": "string",
                    "value": "voice-assistant"
                }
            ],
            "encryptedFields": [
                "X-Api-Key"
            ],
            "backoffPlan": {
                "type": "exponential",
                "maxRetries": 3,
                "baseDelaySeconds": 2,
                "excludedStatusCodes": [
                    400,
                    404
                ]
            },
            "credentialId": "3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b"
        },
        "variable_extraction_plan": {
            "properties": [
                {
                    "name": "orderStatus",
                    "type": "string",
                    "description": "Current status of the order",
                    "required": false
                }
            ],
            "aliases": [
                {
                    "key": "status",
                    "value": "orderStatus"
                }
            ]
        },
        "destinations": null,
        "rejection_plan": {
            "conditions": [
                {
                    "type": "regex",
                    "value": "^(cancelled|refunded)$"
                }
            ]
        },
        "messages": [
            {
                "type": "request-start",
                "content": "Let me check on that order for you."
            },
            {
                "type": "request-failed",
                "content": "I'm having trouble reaching our order system right now."
            }
        ],
        "metadata": {
            "category": "orders"
        },
        "async": false,
        "created_at": "2026-07-30T14:22:03+00:00",
        "updated_at": "2026-07-30T14:22:03+00:00",
        "user": {
            "id": 42,
            "name": "Jane Cooper",
            "email": "[email protected]"
        },
        "creator": {
            "id": 42,
            "name": "Jane Cooper",
            "email": "[email protected]"
        },
        "read_only": false,
        "coreData": {
            "id": "d4e5f6a7-8b9c-4a1d-9e2f-3a4b5c6d7e8f"
        }
    }
}