Skip to main content
POST
/
tool
cURL
curl --request POST \\
  --url https://voip-middlware.superu.ai/tool \\
  --header 'superU-Api-Key: YOUR_SUPERU_API_KEY' \\
  --data '{
  "name": "check-user-status",
  "description": "Check if a user exists in the database",
  "parameters": {
    "type": "object",
    "properties": {
      "email": {
        "type": "string",
        "description": "User email"
      }
    },
    "required": [
      "email"
    ]
  },
  "tool_url": "/api/check-user",
  "tool_url_domain": "https://your-api.com",
  "type": "http",
  "async_": false
}'
{
  "status": "success",
  "tool_id": "tool_01HXR9259WDZ2X3ZZKQ7HDG4C2",
  "message": "Tool created"
}

Authorizations

​
superU-Api-Key
string
header
required

Your SuperU API key.

Body

application/json

Request body for Create tool.

Tool Create Request schema.

​
name
string
required

Tool name

Example:

"check-user-status"

​
description
string
required

What the tool does

Example:

"Check if a user exists in the database"

​
parameters
object
required

JSON schema-like parameter definition

Example:
{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "User email"
    }
  },
  "required": ["email"]
}
​
tool_url
string
required

Endpoint path for tool execution

Example:

"/api/check-user"

​
tool_url_domain
string
required

Base domain for tool execution

Example:

"https://your-api.com"

​
type
string

Optional tool type

Example:

"http"

​
async_
boolean

Whether the tool runs asynchronously

Example:

false

Response

Tool created

Generic Response schema.

​
status
string

Status value.

Example:

"success"

​
message
string

Message value.

Example:

"Request completed successfully"

​
data
object

Data value.