List tools

GET

/v1/convai/tools

GET

/v1/convai/tools

curl -G https://api.elevenlabs.io/v1/convai/tools \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d show_only_owned_documents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d types=webhook \
     -d used_by_agent_id=used_by_agent_id

{
  "tools": [
    {
      "id": "id",
      "tool_config": {
        "type": "client",
        "description": "description",
        "name": "name",
        "assignments": [
          {
            "dynamic_variable": "user_name",
            "value_path": "user.name",
            "source": "response",
            "sanitize": false,
            "preserve_native_type": false
          }
        ],
        "dynamic_variables": {
          "dynamic_variable_placeholders": {
            "user_name": "John Doe"
          }
        },
        "expects_response": false
      },
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "usage_stats": {
        "avg_latency_secs": 1.1
      },
      "response_mocks": [
        {
          "mock_result": "mock_result"
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Get all available tools in the workspace.

Query parameters

searchstringOptional

If specified, the endpoint returns only tools whose names start with this string.

page_sizeintegerOptional1-100

How many documents to return at maximum. Can not exceed 100, defaults to 30.

show_only_owned_documentsbooleanOptionalDefaults to falseDeprecated

If set to true, the endpoint will return only tools owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead.

created_by_user_idstringOptional

Filter tools by creator user ID. When set, only tools created by this user are returned. Takes precedence over show_only_owned_documents. Use ‘@me’ to refer to the authenticated user.

typesenumOptional

If present, the endpoint will return only tools of the given types.

Allowed values:

sort_directionenumOptional

The direction to sort the results

Allowed values:

sort_byenumOptional

The field to sort the results by

Allowed values:

used_by_agent_idstringOptional

Filter to tools referenced by this agent’s main branch: tools attached to the agent, tools on authored workflow nodes, and tools referenced by procedures.

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

toolslist of objects

has_moreboolean

next_cursorstringOptional

Errors

422

Tools List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors