--- title: "Get Knowledge Base List" method: GET path: "/v1/convai/knowledge-base" tags: ["Agents Platform"] --- # Get Knowledge Base List `GET /v1/convai/knowledge-base` Get a list of available knowledge base documents ## Query parameters - `page_size` integer — How many documents to return at maximum. Can not exceed 100, defaults to 30. - `search` string, nullable — If specified, the endpoint returns only such knowledge base documents whose names start with this string. - `show_only_owned_documents` boolean — 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_id` string, 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. - `types` KnowledgeBaseDocumentType[], nullable — If present, the endpoint will return only documents of the given types. - `parent_folder_id` string, nullable — If set, the endpoint will return only documents that are direct children of the given folder. - `ancestor_folder_id` string, nullable — If set, the endpoint will return only documents that are descendants of the given folder. - `folders_first` boolean — Whether folders should be returned first in the list of documents. - `sort_direction` 'asc' | 'desc' - `sort_by` 'name' | 'created_at' | 'updated_at' | 'size' - `cursor` string, nullable — Used for fetching next page. Cursor is returned in the response. ## Headers - `xi-api-key` string, 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. ## Response `200` Successful Response - GetKnowledgeBaseListResponseModel - `documents` union[], required - union - GetKnowledgeBaseSummaryURLResponseModel - `id` string, required - `name` string, required - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required - `created_at_unix_secs` integer, required - `last_updated_at_unix_secs` integer, required - `size_bytes` integer, required - `supported_usages` DocumentUsageModeEnum[], required - `access_info` ResourceAccessInfo, required - `is_creator` boolean, required — Whether the user making the request is the creator of the agent - `creator_name` string, required — Name of the agent's creator - `creator_email` string, required — Email of the agent's creator - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly. - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them. - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level. - `folder_path` KnowledgeBaseFolderPathSegmentSummaryResponseModel[] — The folder path segments leading to this entity, from root to parent folder. - `id` string, required - `dependent_agents` union[], required — This field is deprecated and will be removed in the future, use the separate endpoint to get dependent agents instead. - union - DependentAvailableAgentIdentifier - … - DependentUnknownAgentIdentifier — A model that represents an agent dependent on a knowledge base/tools to which the user has no direct access. - … - `type` 'url', required - `url` string, required - `auto_sync_info` AutoSyncInfo - `minimum_frequency_days` integer — Maximum number of days between automatic syncs - `auto_remove` boolean — Whether to remove the document if the URL becomes unavailable - `consec_failures` integer — Number of consecutive sync failures - `next_refresh_by` integer, nullable — Unix timestamp for the next scheduled sync or None (in case of folders) - GetKnowledgeBaseSummaryFileResponseModel - `id` string, required - `name` string, required - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required - `created_at_unix_secs` integer, required - `last_updated_at_unix_secs` integer, required - `size_bytes` integer, required - `supported_usages` DocumentUsageModeEnum[], required - `access_info` ResourceAccessInfo, required - `is_creator` boolean, required — Whether the user making the request is the creator of the agent - `creator_name` string, required — Name of the agent's creator - `creator_email` string, required — Email of the agent's creator - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly. - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them. - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level. - `folder_path` KnowledgeBaseFolderPathSegmentSummaryResponseModel[] — The folder path segments leading to this entity, from root to parent folder. - `id` string, required - `dependent_agents` union[], required — This field is deprecated and will be removed in the future, use the separate endpoint to get dependent agents instead. - union - DependentAvailableAgentIdentifier - … - DependentUnknownAgentIdentifier — A model that represents an agent dependent on a knowledge base/tools to which the user has no direct access. - … - `type` 'file', required - `external_sync_info` ExternalFileSyncInfo — Tracks the link back to the original file in an external source. - `type` 'google_drive', required - `source_entity_id` string, required — Entity ID in the external system - `integration_connection_id` string, required — Integration connection instance ID - `source_parent_entity_id` string, required — Folder ID in the external system this file was synced from - `source_mime_type` string, required — Original MIME type in the external system - `source_modified_time` string, date-time, required — Last modified time from the external system - `root_folder_id` string, nullable — KB folder ID of the sync root, used to query all entities under a sync tree - `auto_sync_info` AutoSyncInfo - `minimum_frequency_days` integer — Maximum number of days between automatic syncs - `auto_remove` boolean — Whether to remove the document if the URL becomes unavailable - `consec_failures` integer — Number of consecutive sync failures - `next_refresh_by` integer, nullable — Unix timestamp for the next scheduled sync or None (in case of folders) - `refresh_status` FileRefreshStatus — In-flight/last refresh state for an externally-synced KB file. - `status` 'queued' | 'processing' | 'succeeded' | 'failed' | 'skipped' | 'cancelled' - `enqueued_at` integer, nullable - `started_at` integer, nullable - `completed_at` integer, nullable - `last_synced_at` integer, nullable - `error_message` string, nullable - `is_frozen` boolean - GetKnowledgeBaseSummaryTextResponseModel - `id` string, required - `name` string, required - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required - `created_at_unix_secs` integer, required - `last_updated_at_unix_secs` integer, required - `size_bytes` integer, required - `supported_usages` DocumentUsageModeEnum[], required - `access_info` ResourceAccessInfo, required - `is_creator` boolean, required — Whether the user making the request is the creator of the agent - `creator_name` string, required — Name of the agent's creator - `creator_email` string, required — Email of the agent's creator - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly. - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them. - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level. - `folder_path` KnowledgeBaseFolderPathSegmentSummaryResponseModel[] — The folder path segments leading to this entity, from root to parent folder. - `id` string, required - `dependent_agents` union[], required — This field is deprecated and will be removed in the future, use the separate endpoint to get dependent agents instead. - union - DependentAvailableAgentIdentifier - … - DependentUnknownAgentIdentifier — A model that represents an agent dependent on a knowledge base/tools to which the user has no direct access. - … - `type` 'text', required - GetKnowledgeBaseSummaryFolderResponseModel - `id` string, required - `name` string, required - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required - `created_at_unix_secs` integer, required - `last_updated_at_unix_secs` integer, required - `size_bytes` integer, required - `supported_usages` DocumentUsageModeEnum[], required - `access_info` ResourceAccessInfo, required - `is_creator` boolean, required — Whether the user making the request is the creator of the agent - `creator_name` string, required — Name of the agent's creator - `creator_email` string, required — Email of the agent's creator - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly. - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them. - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level. - `folder_path` KnowledgeBaseFolderPathSegmentSummaryResponseModel[] — The folder path segments leading to this entity, from root to parent folder. - `id` string, required - `dependent_agents` union[], required — This field is deprecated and will be removed in the future, use the separate endpoint to get dependent agents instead. - union - DependentAvailableAgentIdentifier - … - DependentUnknownAgentIdentifier — A model that represents an agent dependent on a knowledge base/tools to which the user has no direct access. - … - `type` 'folder', required - `children_count` integer, required - `document_count` integer, required — Number of non-folder documents anywhere in this folder's subtree (recursive). Counting stops past 1000; - `auto_sync_info` AutoSyncInfo - `minimum_frequency_days` integer — Maximum number of days between automatic syncs - `auto_remove` boolean — Whether to remove the document if the URL becomes unavailable - `consec_failures` integer — Number of consecutive sync failures - `next_refresh_by` integer, nullable — Unix timestamp for the next scheduled sync or None (in case of folders) - `external_sync_info` ExternalFolderSyncInfo — Metadata for a KB folder that mirrors an external source folder. - `type` 'google_drive', required - `source_entity_id` string, required — Entity ID in the external system - `integration_connection_id` string, required — Integration connection instance ID - `root_folder_id` string, nullable — KB folder ID of the sync root. None means this folder is the root. - `sync_cursor` string, nullable — Opaque cursor for incremental sync, interpreted by the provider - `last_sync_at` integer, nullable — Unix timestamp of last completed sync - `is_frozen` boolean - `next_cursor` string, nullable - `has_more` boolean, required ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/versions/e77a0a530a82/schema)