Skip to main content
POST
/
api
/
tools
Create Tool
curl --request POST \
  --url https://api.example.com/api/tools

​
Request

curl -X POST https://app.orova.ai/api/tools \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Check Order Status",
    "type": "http",
    "description": "Use when the caller asks about their order status",
    "workspaceId": "WORKSPACE_ID",
    "config": {
      "method": "GET",
      "url": "https://api.yourcompany.com/orders/{order_id}",
      "headers": {
        "Authorization": "Bearer YOUR_BACKEND_TOKEN"
      }
    },
    "parameters": [
      {
        "name": "order_id",
        "description": "The customer order number",
        "required": true
      }
    ]
  }'

​
Parameters

FieldTypeRequiredDescription
namestringYesTool display name
typestringYesTool type: http, integration, or transfer
descriptionstringYesTells the agent when to use this tool
workspaceIdstringYesWorkspace ID
templateIdstringNoIntegration template ID (for integration tools)
configobjectNoHTTP config: method, url, headers, body
parametersarrayNoParameters the agent extracts from the conversation

​
Response

{
  "_id": "tool_abc123",
  "name": "Check Order Status",
  "type": "http",
  "description": "Use when the caller asks about their order status",
  "workspaceId": "WORKSPACE_ID",
  "config": {
    "method": "GET",
    "url": "https://api.yourcompany.com/orders/{order_id}"
  },
  "createdAt": "2025-01-01T00:00:00.000Z"
}