Skip to main content
POST
Create Agent Tool

Authorizations

string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

Body

string
The internal name of the resource. Use a clear name that your team can recognize in the dashboard and API responses.
string
A short description of the resource. Use it to explain the purpose, behavior, or usage context.
string
The tool type. Use the value that matches how the agent should execute the tool, such as an API or integration tool.
object
The tool definition object. Include the schema, parameters, and execution details required by the tool type.

Response

boolean
Whether the request succeeded.
string
Human-readable status message.
object
Returned data.

Transfer Call tool (example)

Example request to create a transfer_call tool:
Example response:
200

End Call tool (example)

Request payload:
Response (demo IDs):
200

Custom webhook tool (example)

Request payload:
Response:
200

IVR press_digit tool (example)

Request payload:
Response (demo values):
200

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string

Tool name

description
string

Tool description

type
string

Tool type (e.g. webhook, function)

definition
object

Tool definition schema

Response

200 - application/json

Successful response

success
boolean
message
string
data
object