Sign in

Retrieve details of a specific knowledge base

get/get-knowledge-base/{knowledge_base_id}

Path parameters

knowledge_base_idstring required
Example:kb_1234567890

The knowledge base id to retrieve.

Response

Successfully retrieved a knowledge base.

knowledge_base_idstring required

Unique id of the knowledge base.

knowledge_base_namestring required

Name of the knowledge base. Must be less than 40 characters.

status'in_progress' | 'complete' | 'error' | 'refreshing_in_progress' required

Status of the knowledge base. When it's created and being processed, it's "in_progress". When the processing is done, it's "complete". When there's an error in processing, it's "error". When it is during kb updating, it's "refreshing_in_progress".

max_chunk_sizeinteger

Maximum number of characters per chunk when splitting knowledge base content.

min_chunk_sizeinteger

Minimum number of characters per chunk. Chunks smaller than this are merged with adjacent chunks.

enable_auto_refreshboolean

Whether to enable auto refresh for the knowledge base urls. If set to true, will retrieve the data from the specified url every 12 hours.

last_refreshed_timestampinteger

Last refreshed timestamp (milliseconds since epoch). Only applicable when enable_auto_refresh is true.

Example response

{
  "knowledge_base_id": "knowledge_base_a456426614174000",
  "knowledge_base_name": "Sample KB",
  "status": "in_progress",
  "max_chunk_size": 2000,
  "min_chunk_size": 400,
  "enable_auto_refresh": true,
  "last_refreshed_timestamp": 1703413636133
}

Changes

Changed in 2 of the 28 revisions of this API.3

  • 6342a99901081See the full diff
    • ○

      added the required property ////// to the response with the status

      response-required-property-added

  • e89903d2c9102See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

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