List knowledge base documents

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

Get a list of available knowledge base documents

Parametry zapytania

page_sizeintegerOpcjonalny1-100Domyślnie 30

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

searchstringOpcjonalny

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

show_only_owned_documentsbooleanOpcjonalnyDomyślnie falseDeprecated

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

created_by_user_idstringOpcjonalny

Filter documents by creator user ID. When set, only documents created by this user are returned. Takes precedence over show_only_owned_documents. Use ‘@me’ to refer to the authenticated user.

typesenumOpcjonalny

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

Dozwolone wartości:

parent_folder_idstringOpcjonalny

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

ancestor_folder_idstringOpcjonalny

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

folders_firstbooleanOpcjonalnyDomyślnie false

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

sort_directionenumOpcjonalny

The direction to sort the results

Dozwolone wartości:

sort_byenumOpcjonalny

The field to sort the results by

Dozwolone wartości:

cursorstringOpcjonalny

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

Odpowiedź

Successful Response

documentslist of objects

has_moreboolean

next_cursorstringOpcjonalny

Błędy

422

Knowledge Base List Request Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy