지식 베이스 목록 가져오기

GET

/v1/convai/knowledge-base

GET

/v1/convai/knowledge-base

curl -G https://api.elevenlabs.io/v1/convai/knowledge-base \
     -d ancestor_folder_id=ancestor_folder_id \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d folders_first=true \
     -d page_size=1 \
     -d parent_folder_id=parent_folder_id \
     -d search=search \
     -d show_only_owned_documents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d types=file

{
  "documents": [
    {
      "type": "file",
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "id": "id",
      "metadata": {
        "created_at_unix_secs": 1,
        "last_updated_at_unix_secs": 1,
        "size_bytes": 1
      },
      "name": "name",
      "supported_usages": [
        "prompt"
      ],
      "dependent_agents": [
        {
          "type": "available",
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "id",
          "name": "name"
        }
      ],
      "external_sync_info": {
        "type": "google_drive",
        "source_entity_id": "source_entity_id",
        "integration_connection_id": "integration_connection_id",
        "source_parent_entity_id": "source_parent_entity_id",
        "source_mime_type": "source_mime_type",
        "source_modified_time": "2024-01-15T09:30:00Z"
      },
      "folder_parent_id": "folder_parent_id",
      "folder_path": [
        {
          "id": "id"
        }
      ],
      "is_frozen": true
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

사용 가능한 지식 베이스 문서 목록을 가져옵니다.

쿼리 매개변수

page_sizeinteger선택 사항1-100기본값 30

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

searchstring선택 사항

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

show_only_owned_documentsboolean선택 사항기본값 falseDeprecated

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

created_by_user_idstring선택 사항

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

typesenum선택 사항

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

허용된 값:

parent_folder_idstring선택 사항

설정하면 엔드포인트는 지정한 폴더의 직접 하위 문서만 반환합니다.

ancestor_folder_idstring선택 사항

설정하면 엔드포인트는 지정한 폴더의 하위 문서만 반환합니다.

folders_firstboolean선택 사항기본값 false

문서 목록에서 폴더를 먼저 반환할지 여부입니다.

sort_directionenum선택 사항

결과 정렬 방향

허용된 값:

sort_byenum선택 사항

결과를 정렬할 필드

허용된 값:

cursorstring선택 사항

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

응답

성공 응답

documentslist of objects

has_moreboolean

next_cursorstring선택 사항

오류

422

Knowledge Base List Request Unprocessable Entity Error

헤더

쿼리 매개변수

응답

오류