List knowledge base documents

from elevenlabs import ElevenLabs
client = ElevenLabs(
    base_url="https://api.elevenlabs.io"
)
client.conversational_ai.knowledge_base.list(
    page_size=1,
    search="search",
    show_only_owned_documents=True,
    parent_folder_id="parent_folder_id",
    ancestor_folder_id="ancestor_folder_id",
    folders_first=True,
    sort_direction="asc",
    sort_by="name",
    cursor="cursor"
)

{
  "documents": [
    {
      "type": "file",
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin"
      },
      "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"
        }
      ],
      "folder_parent_id": "folder_parent_id",
      "folder_path": [
        {
          "id": "id"
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Get a list of available knowledge base documents

Query parameters

page_sizeintegerOptional1-100Defaults to 30

How many documents to return at maximum. Can not exceed 100, defaults to 30.

searchstringOptional

If specified, the endpoint returns only such knowledge base documents whose names start with this string.

show_only_owned_documentsbooleanOptionalDefaults to false

If set to true, the endpoint will return only documents owned by you (and not shared from somebody else).

typesenumOptional

If present, the endpoint will return only documents of the given types.

Allowed values:

parent_folder_idstringOptional

If set, the endpoint will return only documents that are direct children of the given folder.

ancestor_folder_idstringOptional

If set, the endpoint will return only documents that are descendants of the given folder.

folders_firstbooleanOptionalDefaults to false

Whether folders should be returned first in the list of documents.

sort_directionenumOptional

The direction to sort the results

Allowed values:

sort_byenumOptional

The field to sort the results by

Allowed values:

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

documentslist of objects

has_moreboolean

next_cursorstring or null

Headers

Query parameters

Response

Errors