Tools abrufen

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

Alle verfügbaren Tools im Workspace abrufen.

Abfrageparameter

searchstringOptional

Falls angegeben, gibt der Endpunkt nur Tools zurück, deren Namen mit dieser Zeichenfolge beginnen.

page_sizeintegerOptional1-100

Maximale Anzahl zurückzugebender Dokumente. Darf 100 nicht überschreiten, Standardwert ist 30.

show_only_owned_documentsbooleanOptionalStandardwert ist falseDeprecated

Wenn auf true gesetzt, gibt der Endpunkt nur Tools zurück, die Ihnen gehören und nicht von anderen freigegeben wurden. Veraltet: Verwenden Sie stattdessen created_by_user_id.

created_by_user_idstringOptional

Tools nach der Nutzer-ID des Erstellers filtern. Wenn festgelegt, werden nur von diesem Nutzer erstellte Tools zurückgegeben. Hat Vorrang vor show_only_owned_documents. Verwenden Sie ‘@me’ für den authentifizierten Nutzer.

typesenumOptional

Falls vorhanden, gibt der Endpunkt nur Tools der angegebenen Typen zurück.

Erlaubte Werte:

sort_directionenumOptional

Die Richtung zum Sortieren der Ergebnisse

Erlaubte Werte:

sort_byenumOptional

Das Feld, nach dem die Ergebnisse sortiert werden

Erlaubte Werte:

used_by_agent_idstringOptional

Filtert nach Tools, auf die im Hauptzweig dieses Agenten verwiesen wird: dem Agenten zugeordnete Tools, Tools in erstellten Workflow-Knoten und Tools, auf die in Prozeduren verwiesen wird.

cursorstringOptional

Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

Antwort

Erfolgreiche Antwort

toolslist of objects

has_moreboolean

next_cursorstringOptional

Fehler

422

Tools List Request Unprocessable Entity Error

Header

Abfrageparameter

Antwort

Fehler