도구 가져오기

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

워크스페이스에서 사용할 수 있는 모든 도구를 가져옵니다.

쿼리 매개변수

searchstring선택 사항

지정하면 엔드포인트는 이름이 이 문자열로 시작하는 도구만 반환합니다.

page_sizeinteger선택 사항1-100

반환할 최대 문서 수입니다. 100을 초과할 수 없으며 기본값은 30입니다.

show_only_owned_documentsboolean선택 사항기본값 falseDeprecated

true로 설정하면 엔드포인트는 소유한 도구만 반환하며, 다른 사용자가 공유한 도구는 반환하지 않습니다. 더 이상 사용되지 않음: 대신 created_by_user_id를 사용하세요.

created_by_user_idstring선택 사항

생성자 사용자 ID로 도구를 필터링합니다. 설정하면 이 사용자가 생성한 도구만 반환됩니다. show_only_owned_documents보다 우선합니다. 인증된 사용자를 가리키려면 ‘@me’를 사용하세요.

typesenum선택 사항

지정하면 엔드포인트는 해당 유형의 도구만 반환합니다.

허용된 값:

sort_directionenum선택 사항

결과 정렬 방향

허용된 값:

sort_byenum선택 사항

결과를 정렬할 필드

허용된 값:

used_by_agent_idstring선택 사항

이 에이전트의 기본 브랜치에서 참조하는 도구로 필터링합니다. 에이전트에 연결된 도구, 작성된 workflow 노드의 도구 및 절차에서 참조하는 도구가 포함됩니다.

cursorstring선택 사항

다음 페이지를 가져오는 데 사용됩니다. 응답에서 커서가 반환됩니다.

응답

성공 응답

toolslist of objects

has_moreboolean

next_cursorstring선택 사항

오류

422

Tools List Request Unprocessable Entity Error

헤더

쿼리 매개변수

응답

오류