Sign in
Agents Platform

Get Knowledge Base Summaries By Ids

Gets multiple knowledge base document summaries by their IDs.

get/v1/convai/knowledge-base/summaries

Query parameters

document_idsstring[] required

The ids of knowledge base documents.

The ids of knowledge base documents.

[
  "21m00Tcm4TlvDq8ikWAM",
  "31n11Udm5UmwEr9jkXBN"
]

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

object required

Changes

Changed in 1 of the 29 revisions of this API.3

  • 494d96419d153See the full diff
    • ○

      added the optional property additionalProperties/oneOf[subschema #1: KnowledgeBaseSummaryBatchSuccessfulResponseModel]/data/oneOf[subschema #2: GetKnowledgeBaseSummaryFileResponseModel]/auto_sync_info to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property additionalProperties/oneOf[subschema #1: KnowledgeBaseSummaryBatchSuccessfulResponseModel]/data/oneOf[subschema #2: GetKnowledgeBaseSummaryFileResponseModel]/refresh_status to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property additionalProperties/oneOf[subschema #1: KnowledgeBaseSummaryBatchSuccessfulResponseModel]/data/oneOf[subschema #4: GetKnowledgeBaseSummaryFolderResponseModel]/document_count to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog