Skip to main content
POST
Create an API tool

Authorizations

x-public-key
string
header
required
x-private-key
string
header
required

Headers

x-public-key
string
required
x-private-key
string
required
workspace
string
required

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Check Order Status"

description
string
required

Tells the agent when to trigger this tool.

Minimum string length: 1
Example:

"Look up the current status of a customer order by its ID."

url
string<uri>
required
Example:

"https://api.example.com/orders/status"

method
enum<string>
required
Available options:
get,
post,
put,
patch,
delete
Example:

"post"

headers
object[]
parameters
object
isActive
boolean
default:true

Response

API tool created successfully

message
string
Example:

"API tool created successfully."

data
object

A user-defined API tool the assistant can invoke.