Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Get Knowledge Base List

Get a list of available knowledge base documents

get/v1/convai/knowledge-base

Query parameters

page_sizeinteger

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

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

searchstring nullable

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

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

show_only_owned_documentsboolean

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.

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_idstring nullable

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.

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.

typesKnowledgeBaseDocumentType[] nullable

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

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

parent_folder_idstring nullable

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

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

ancestor_folder_idstring nullable

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

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

folders_firstboolean

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

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

sort_direction'asc' | 'desc'

The direction to sort the results

sort_by'name' | 'created_at' | 'updated_at' | 'size'

The field to sort the results by

cursorstring nullable

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

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

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable
has_moreboolean required

Example response

{
  "documents": [
    {
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      }
    }
  ]
}