Create Tool

Authorizations

Authorization

string

header

required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json

type

enum<string>

required

The type of tool. "function" for Function tool.

Available options:

function

async

boolean

This determines if the tool is async.

If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.

If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.

Defaults to synchronous (false).

Example:

false

function

object

This is the function definition of the tool.

Show child attributes

function.name

string

required

This is the the name of the function to be called.

Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Maximum string length: 64

Example:

"getUserDetailsByPhoneNumber"

function.description

string

This is the description of what the function does, used by the AI to choose when and how to call the function.

Maximum string length: 1000

Example:

"Get user details by phone number, Run this tool when you want user details like name, dob etc by their phone number"

function.parameters

object

These are the parameters the functions accepts, described as a JSON Schema object.

See the OpenAI guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

Show child attributes

function.parameters.type

enum<string>

required

This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.

Available options:

object

Example:

"object"

function.parameters.properties

object

required

This provides a description of the properties required by the function. JSON Schema can be used to specify expectations for each property. Refer to this doc for a comprehensive guide on JSON Schema.

Show child attributes

function.parameters.properties.{key}

object

Show child attributes

function.parameters.properties.{key}.type

enum<string>

required

This is the type of output you'd like.

string, number, integer, boolean are the primitive types and should be obvious.

array and object are more interesting and quite powerful. They allow you to define nested structures.

For array, you can define the schema of the items in the array using the items property.

For object, you can define the properties of the object using the properties property.

Available options:

string,

number,

integer,

boolean,

array,

object

function.parameters.properties.{key}.items

object

This is required if the type is "array". This is the schema of the items in the array.

This is of type JsonSchema. However, Swagger doesn't support circular references.

function.parameters.properties.{key}.properties

object

This is required if the type is "object". This specifies the properties of the object.

This is a map of string to JsonSchema. However, Swagger doesn't support circular references.

function.parameters.properties.{key}.description

string

This is the description to help the model understand what it needs to output.

function.parameters.properties.{key}.required

string[]

This is a list of properties that are required.

This only makes sense if the type is "object".

Example:

{
  "dob": {
    "type": "string",
    "format": "date",
    "description": "This is the date of birth of the user.",
    "example": "1990-03-08"
  },
  "phoneNumber": {
    "type": "string",
    "description": "This is the phone number of the user.",
    "example": "+919867543210"
  }
}

function.parameters.required

string[]

This specifies the properties that are required by the function.

Example:

["phoneNumber"]

function.parameters.additionalProperties

boolean

default:false

This is a boolean that controls whether additional properties are allowed in the function call. If set to false, the model will only accept the properties defined in the parameters field.

@default false

function.strict

boolean

default:false

This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the OpenAI guide.

@default false

messages

(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]

These are the messages that will be spoken to the user as the tool is running.

ToolMessageStart
ToolMessageComplete
ToolMessageFailed
ToolMessageDelayed

Show child attributes

messages.type

enum<string>

required

This message is triggered when the tool call starts.

This message is never triggered for async tools.

If this message is not provided, one of the default filler messages "Hold on a sec", "One moment", "Just a sec", "Give me a moment" or "This'll just take a sec" will be used.

Available options:

request-start

messages.content

string

This is the content that the assistant says when this message is triggered.

Maximum string length: 1000

Example:

"Please wait while I fetch the details."

server

object

This is the server that will be hit when this tool is requested by the model.

All requests will be sent with the call object among other things.

Show child attributes

server.url

string

required

API endpoint to send requests to.

Example:

"https://api.example.com/v1/getUserDetails"

server.timeoutSeconds

number

This is the timeout in seconds for the request to your server. Defaults to 20 seconds.

@default 20

Required range: 1 <= x <= 120

Example:

20

server.secret

string

This is the secret you can set that Interactly will send with every request to your server. Will be sent as a header called x-interactly-secret.

Example:

"my-secret"

server.headers

object

These are the custom headers to include in the request sent to your server.

Each key-value pair represents a header name and its value.

Example:

{}

Response

_id

string

required

This is the unique identifier for the tool.

Example:

"1f7b1b1b1b1b1b1b1b1b1b1b"

teamId

string

required

This is the unique identifier for the organization that this tool belongs to.

Example:

"3f7b1b1b1b1b1b1b1b1b1b1b"

type

enum<string>

required

The type of tool. "function" for Function tool.

Available options:

function

Example:

"function"

async

boolean

This determines if the tool is async.

If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.

If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.

Defaults to synchronous (false).

Example:

false

function

object

This is the function definition of the tool.

Show child attributes

function.name

string

required

This is the the name of the function to be called.

Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Maximum string length: 64

Example:

"getUserDetailsByPhoneNumber"

function.description

string

This is the description of what the function does, used by the AI to choose when and how to call the function.

Maximum string length: 1000

Example:

"Get user details by phone number, Run this tool when you want user details like name, dob etc by their phone number"

function.parameters

object

These are the parameters the functions accepts, described as a JSON Schema object.

See the OpenAI guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

Show child attributes

function.parameters.type

enum<string>

required

This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.

Available options:

object

Example:

"object"

function.parameters.properties

object

required

This provides a description of the properties required by the function. JSON Schema can be used to specify expectations for each property. Refer to this doc for a comprehensive guide on JSON Schema.

Show child attributes

function.parameters.properties.{key}

object

Show child attributes

function.parameters.properties.{key}.type

enum<string>

required

This is the type of output you'd like.

string, number, integer, boolean are the primitive types and should be obvious.

array and object are more interesting and quite powerful. They allow you to define nested structures.

For array, you can define the schema of the items in the array using the items property.

For object, you can define the properties of the object using the properties property.

Available options:

string,

number,

integer,

boolean,

array,

object

function.parameters.properties.{key}.items

object

This is required if the type is "array". This is the schema of the items in the array.

This is of type JsonSchema. However, Swagger doesn't support circular references.

function.parameters.properties.{key}.properties

object

This is required if the type is "object". This specifies the properties of the object.

This is a map of string to JsonSchema. However, Swagger doesn't support circular references.

function.parameters.properties.{key}.description

string

This is the description to help the model understand what it needs to output.

function.parameters.properties.{key}.required

string[]

This is a list of properties that are required.

This only makes sense if the type is "object".

Example:

{
  "dob": {
    "type": "string",
    "format": "date",
    "description": "This is the date of birth of the user.",
    "example": "1990-03-08"
  },
  "phoneNumber": {
    "type": "string",
    "description": "This is the phone number of the user.",
    "example": "+919867543210"
  }
}

function.parameters.required

string[]

This specifies the properties that are required by the function.

Example:

["phoneNumber"]

function.parameters.additionalProperties

boolean

default:false

This is a boolean that controls whether additional properties are allowed in the function call. If set to false, the model will only accept the properties defined in the parameters field.

@default false

function.strict

boolean

default:false

@default false

messages

(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]

These are the messages that will be spoken to the user as the tool is running.

ToolMessageStart
ToolMessageComplete
ToolMessageFailed
ToolMessageDelayed

Show child attributes

messages.type

enum<string>

required

This message is triggered when the tool call starts.

This message is never triggered for async tools.

If this message is not provided, one of the default filler messages "Hold on a sec", "One moment", "Just a sec", "Give me a moment" or "This'll just take a sec" will be used.

Available options:

request-start

messages.content

string

This is the content that the assistant says when this message is triggered.

Maximum string length: 1000

Example:

"Please wait while I fetch the details."

server

object

This is the server that will be hit when this tool is requested by the model.

All requests will be sent with the call object among other things.

Show child attributes

server.url

string

required

API endpoint to send requests to.

Example:

"https://api.example.com/v1/getUserDetails"

server.timeoutSeconds

number

This is the timeout in seconds for the request to your server. Defaults to 20 seconds.

@default 20

Required range: 1 <= x <= 120

Example:

20

server.secret

string

This is the secret you can set that Interactly will send with every request to your server. Will be sent as a header called x-interactly-secret.

Example:

"my-secret"

server.headers

object

These are the custom headers to include in the request sent to your server.

Each key-value pair represents a header name and its value.

Example:

{}

createdAt

string<date-time>

This is the ISO 8601 date-time string of when the record was created.

Example:

"2020-10-05T00:00:00.000Z"

updatedAt

string<date-time>

This is the ISO 8601 date-time string of when the record was last updated.

Example:

"2020-10-05T00:00:00.000Z"

Getting Started

APIs

Campaigns

Authorizations

Body

Response