Obter ferramentas

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

Obtenha todas as ferramentas disponíveis no espaço de trabalho.

Parâmetros de consulta

searchstringOpcional

Se especificado, o endpoint retorna somente ferramentas cujos nomes começam com esta string.

page_sizeintegerOpcional1-100

Quantidade máxima de documentos a retornar. Não pode exceder 100; o padrão é 30.

show_only_owned_documentsbooleanOpcionalPadrão é falseDeprecated

Se definido como true, o endpoint retornará apenas ferramentas que pertencem a você, e não compartilhadas por outras pessoas. Obsoleto: use created_by_user_id.

created_by_user_idstringOpcional

Filtre ferramentas pelo ID do usuário criador. Quando definido, retorna apenas ferramentas criadas por esse usuário. Tem precedência sobre show_only_owned_documents. Use ‘@me’ para se referir ao usuário autenticado.

typesenumOpcional

Se presente, o endpoint retornará apenas ferramentas dos tipos informados.

Valores permitidos:

sort_directionenumOpcional

A direção para ordenar os resultados

Valores permitidos:

sort_byenumOpcional

O campo pelo qual ordenar os resultados

Valores permitidos:

used_by_agent_idstringOpcional

Filtre as ferramentas referenciadas pela ramificação principal deste agente: ferramentas vinculadas ao agente, ferramentas em nós de workflow criados e ferramentas referenciadas por procedimentos.

cursorstringOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

toolslist of objects

has_moreboolean

next_cursorstringOpcional

Erros

422

Tools List Request Unprocessable Entity Error

Cabeçalhos

Parâmetros de consulta

Resposta

Erros