Pobierz narzędzia

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"
}

Pobierz wszystkie dostępne narzędzia w obszarze roboczym.

Parametry zapytania

searchstringOpcjonalny

Jeśli podano, endpoint zwraca tylko narzędzia, których nazwy zaczynają się od tego ciągu.

page_sizeintegerOpcjonalny1-100

Maksymalna liczba dokumentów do zwrócenia. Nie może przekraczać 100, domyślnie 30.

show_only_owned_documentsbooleanOpcjonalnyDomyślnie falseDeprecated

Jeśli ustawiono true, endpoint zwróci tylko narzędzia należące do ciebie, a nie udostępnione przez inne osoby. Przestarzałe: użyj zamiast tego created_by_user_id.

created_by_user_idstringOpcjonalny

Filtruj narzędzia według ID użytkownika, który je utworzył. Po ustawieniu zwracane są tylko narzędzia utworzone przez tego użytkownika. Ma pierwszeństwo przed show_only_owned_documents. Użyj „@me”, aby wskazać uwierzytelnionego użytkownika.

typesenumOpcjonalny

Jeśli podano, endpoint zwróci tylko narzędzia danych typów.

Dozwolone wartości:

sort_directionenumOpcjonalny

Kierunek sortowania wyników

Dozwolone wartości:

sort_byenumOpcjonalny

Pole, według którego sortować wyniki

Dozwolone wartości:

used_by_agent_idstringOpcjonalny

Filtruj narzędzia, do których odwołuje się główna gałąź tego agenta: narzędzia przypisane do agenta, narzędzia w utworzonych węzłach workflow oraz narzędzia, do których odwołują się procedury.

cursorstringOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

toolslist of objects

has_moreboolean

next_cursorstringOpcjonalny

Błędy

422

Tools List Request Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy