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

{
  "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.

Parametry zapytania

searchstringOpcjonalny

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

page_sizeintegerOpcjonalny1-100

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

show_only_owned_documentsbooleanOpcjonalnyDomyślnie 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_idstringOpcjonalny

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.

typesenumOpcjonalny

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

Dozwolone wartości:

sort_directionenumOpcjonalny

The direction to sort the results

Dozwolone wartości:

sort_byenumOpcjonalny

The field to sort the results by

Dozwolone wartości:

cursorstringOpcjonalny

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

Odpowiedź

Successful Response

toolslist of objects

has_moreboolean

next_cursorstringOpcjonalny

Błędy

422

Tools List Request Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy