Skip to main content
POST
/
api
/
v1
/
tool
Create Tool
curl --request POST \
  --url 'https://api.example.com/api/v1/tool?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tool_type": "system",
  "authentication": {},
  "sdk": {},
  "tool_provider": "leadconnector",
  "category": "Calendar",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "base_url": "<string>",
  "logo_url": "<string>",
  "enabled": false,
  "attributes": {}
}
'
{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "description": "<string>",
    "tool_type": "system",
    "authentication": {},
    "sdk": {},
    "tool_provider": "leadconnector",
    "category": "Calendar",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_url": "<string>",
    "logo_url": "<string>",
    "enabled": false,
    "attributes": {}
  }
}

Authorizations

api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Body

application/json
name
string | null
required
description
string | null
required
tool_type
enum<string> | null
required
Available options:
system,
user
authentication
Authentication · object
required
sdk
Sdk · object
required
tool_provider
enum<string> | null
required
Available options:
leadconnector,
hubspot,
google_calendar,
zoho,
freshdesk,
insighto,
modmed,
twilio,
custom,
fb_messenger,
instagram,
paypal,
postgres,
plivo,
telnyx,
telegram
category
enum<string> | null
required
Available options:
Calendar,
CRM,
EHR,
Support,
Communication,
System,
HRMS,
Social,
Others,
Payment,
Database,
MCP
org_id
string<uuid> | null
base_url
string | null
logo_url
string | null
enabled
boolean | null
default:false
attributes
Attributes · object

Response

Successful Response

message
string | null
default:Data created successfully
meta
Meta · object
data
IToolCreate · object