Agents Platform

Add Tool

Changed on

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

post/v1/convai/tools

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/tools
  • Auth
    none declared

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

Example request

{
  "tool_config": {
    "response_timeout_secs": 20,
    "type": "webhook"
  }
}

Response

Successful Response

idstring required

Example response

{
  "tool_config": {
    "response_timeout_secs": 20,
    "type": "webhook"
  },
  "access_info": {
    "access_source": "creator",
    "creator_email": "john.doe@example.com",
    "creator_name": "John Doe",
    "is_creator": true,
    "role": "admin"
  }
}

Changes

  • 46f26f34e316Revision changes
    • info

      added the new optional request property //////

    • info

      added the optional property ////// to the response with the status

  • 5dc5a9b84ae5Revision changes
    • breaking

      the // response property's min was decreased from 1.00 to -1.00 for the response status

    • info

      the // request property's min was decreased from 1.00 to -1.00