Create tool | ElevenLabs Documentation

from elevenlabs import ElevenLabs, ToolRequestModel
client = ElevenLabs()
client.conversational_ai.tools.create(
    request=ToolRequestModel(
        tool_config={
            "type": "client",
            "description": "description",
            "name": "name",
            "expects_response": False
        },
    ),
)

{
  "id": "id",
  "tool_config": {
    "type": "client",
    "description": "description",
    "name": "name",
    "assignments": [
      {
        "dynamic_variable": "user_name",
        "value_path": "user.name",
        "source": "response",
        "sanitize": false
      }
    ],
    "disable_interruptions": true,
    "dynamic_variables": {
      "dynamic_variable_placeholders": {
        "user_name": "John Doe"
      }
    },
    "execution_mode": "immediate",
    "expects_response": false,
    "force_pre_tool_speech": true,
    "parameters": {
      "type": "object",
      "required": [
        "required"
      ],
      "description": "description",
      "properties": {
        "key": {
          "type": "string",
          "description": "A user-provided message"
        }
      }
    },
    "response_timeout_secs": 1,
    "tool_call_sound": "typing",
    "tool_call_sound_behavior": "auto",
    "tool_error_handling_mode": "auto"
  },
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin"
  },
  "usage_stats": {
    "avg_latency_secs": 1.1,
    "total_calls": 1
  },
  "response_mocks": [
    {
      "mock_result": "mock_result",
      "parameter_conditions": [
        {
          "eval": {
            "type": "anything"
          },
          "path": "path"
        }
      ]
    }
  ]
}

Add a new tool to the available tools in the workspace.

Request

A tool that an agent can provide to LLM.

tool_configobjectRequired

Configuration for the tool

response_mockslist of objectsOptional

Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.

Response

Successful Response

idstring

tool_configobject

The type of tool

access_infoobject

usage_statsobject

response_mockslist of objects

Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.

Errors

422

Tools Create Request Unprocessable Entity Error

Headers

Request

Response

Errors