Recupera strumenti

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

Ottieni tutti gli strumenti disponibili nel workspace.

Parametri di query

searchstringOpzionale

Se specificato, l'endpoint restituisce solo gli strumenti i cui nomi iniziano con questa stringa.

page_sizeintegerOpzionale1-100

Numero massimo di documenti da restituire. Non può superare 100; il valore predefinito è 30.

show_only_owned_documentsbooleanOpzionalePredefinito a falseDeprecated

Se impostato su true, l'endpoint restituirà solo gli strumenti di tua proprietà, non condivisi da altri. Deprecato: usa invece created_by_user_id.

created_by_user_idstringOpzionale

Filtra gli strumenti in base all'ID dell'utente creatore. Se impostato, vengono restituiti solo gli strumenti creati da questo utente. Ha la precedenza su show_only_owned_documents. Usa '@me' per fare riferimento all'utente autenticato.

typesenumOpzionale

Se presente, l'endpoint restituirà solo strumenti dei tipi specificati.

Valori consentiti:

sort_directionenumOpzionale

La direzione per ordinare i risultati

Valori consentiti:

sort_byenumOpzionale

Il campo in base al quale ordinare i risultati

Valori consentiti:

used_by_agent_idstringOpzionale

Filtra gli strumenti a cui fa riferimento il branch principale di questo agente: strumenti associati all'agente, strumenti nei nodi del workflow creati e strumenti a cui fanno riferimento le procedure.

cursorstringOpzionale

Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

Risposta

Risposta riuscita

toolslist of objects

has_moreboolean

next_cursorstringOpzionale

Errori

422

Tools List Request Unprocessable Entity Error

Header

Parametri di query

Risposta

Errori