Skip to main content
POST
/
v2
/
ai-agents
/
{ai_agent_id}
/
builtin-tools
Create built-in tool
curl --request POST \
  --url https://api.example.com/v2/ai-agents/{ai_agent_id}/builtin-tools/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_email": "<string>",
  "app_password": "<string>",
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>",
  "tool_description": "<string>",
  "tool_name": "send_email"
}
'
{
  "from_email": "<string>",
  "app_password": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>",
  "tool_description": "<string>",
  "tool_name": "send_email"
}

Path Parameters

​
ai_agent_id
string
required

Body

application/json
​
from_email
string
required

Email address that will be used as the sender for outgoing emails

​
app_password
string
required

Application-specific password for authenticating with the email service

​
tool_id
string
​
tool_start_message
string | null

Optional message to display when the tool is started

​
tool_delayed_message
string | null

Optional message to display when the tool is delayed

​
tool_complete_message
string | null

Optional message to display when the tool is completed

​
tool_failed_message
string | null

Optional message to display when the tool fails

​
tool_description
string | null

Optional description of the email tool's purpose and configuration

​
tool_name
string
default:send_email

Identifier for the email tool type, must be 'send_email'

Allowed value: "send_email"

Response

Successful Response

​
from_email
string
required

Email address configured as sender

​
app_password
string
required

Application-specific password used for authentication

​
created_at
string<date-time>
required

Timestamp when the tool was created

​
updated_at
string<date-time>
required

Timestamp when the tool was last updated

​
tool_id
string

Unique identifier of the email tool

​
tool_start_message
string | null

Optional message to display when the tool is started

​
tool_delayed_message
string | null

Optional message to display when the tool is delayed

​
tool_complete_message
string | null

Optional message to display when the tool is completed

​
tool_failed_message
string | null

Optional message to display when the tool fails

​
tool_description
string | null

Description of the email tool's purpose and configuration

​
tool_name
string
default:send_email

Identifier for the email tool type

Allowed value: "send_email"