Skip to main content
POST
/
tools
/
{toolID}
/
update
Update a tool
curl --request POST \
  --url https://api.cleartalk.ai/tools/{toolID}/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "name": "confirmationNumber",
  "description": "Here's your case reference number",
  "speech": "one moment GP",
  "url": "https://staging.cleartalk.ai/randomNumber",
  "method": "GET",
  "headers": {
    "Content-Type": "application/json"
  },
  "body": {},
  "query": {},
  "input_schema": {},
  "response": {},
  "timeout": 30
}
EOF

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
toolID
string
required

Body

application/json
​
name
string

Name of the tool

Example:

"confirmationNumber"

​
description
string

Description of the tool

Example:

"Here's your case reference number"

​
speech
string

Speech response for the tool

Example:

"one moment GP"

​
url
string

URL endpoint for the tool

Example:

"https://staging.cleartalk.ai/randomNumber"

​
method
enum<string>

HTTP method for the tool

Available options:
GET,
POST,
PUT,
DELETE,
PATCH
Example:

"GET"

​
headers
object

HTTP headers for the request

Example:
{ "Content-Type": "application/json" }
​
body
object

Request body parameters

Example:
{}
​
query
object

Query parameters

Example:
{}
​
input_schema
object

Input schema for the tool

Example:
{}
​
response
object

Response schema for the tool

Example:
{}
​
timeout
number

Timeout in seconds

Example:

30

Response

Tool updated successfully