Obtener herramientas

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

Obtén todas las herramientas disponibles en el espacio de trabajo.

Parámetros de consulta

searchstringOpcional

Si se especifica, la ruta de API devuelve solo las herramientas cuyos nombres comiencen con esta cadena.

page_sizeintegerOpcional1-100

Número máximo de documentos que se devolverán. No puede superar 100; el valor predeterminado es 30.

show_only_owned_documentsbooleanOpcionalValor predeterminado: falseDeprecated

Si se establece en true, la ruta de API devolverá solo las herramientas que te pertenecen (y que no hayan sido compartidas por otra persona). Obsoleto: usa created_by_user_id en su lugar.

created_by_user_idstringOpcional

Filtra herramientas por ID del usuario creador. Cuando se especifica, solo se devuelven las herramientas creadas por este usuario. Tiene prioridad sobre show_only_owned_documents. Usa ‘@me’ para referirte al usuario autenticado.

typesenumOpcional

Si está presente, la ruta de API devolverá solo herramientas de los tipos indicados.

Valores permitidos:

sort_directionenumOpcional

La dirección para ordenar los resultados

Valores permitidos:

sort_byenumOpcional

El campo por el que se ordenarán los resultados

Valores permitidos:

used_by_agent_idstringOpcional

Filtra las herramientas a las que hace referencia la rama principal de este agente: herramientas asociadas al agente, herramientas en nodos de workflow creados y herramientas a las que hacen referencia los procedimientos.

cursorstringOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.

toolslist of objects

has_moreboolean

next_cursorstringOpcional

Errores

422

Tools List Request Unprocessable Entity Error

Encabezados

Parámetros de consulta

Respuesta

Errores