Knowledge Bases

Retrieve a knowledge base

Returns a single knowledge base with its files and a summary of their ingestion states.

get/knowledge-bases/{kb_id}

Request

  • Base URL: https://console.hyperstack.cloud/ai/api/v1
  • URL: https://console.hyperstack.cloud/ai/api/v1/knowledge-bases/{kb_id}
  • Auth: API key in header api_key

Path parameters

kb_idinteger required

Numeric ID of the knowledge base. Call the List knowledge bases API to retrieve the id of an existing knowledge base.

Response

The knowledge base.

idinteger

Unique numeric identifier for the knowledge base.

uuidstring

Stable string identifier, prefixed with kb-.

namestring

Name you gave the knowledge base. Unique among your knowledge bases.

descriptionstring nullable

Optional description of what the knowledge base holds.

status'active' | 'processing' | 'failed' | 'deleting'

Current state of the knowledge base.

embedding_modelstring

Model used to embed this knowledge base's content.

created_atstring date-time

Timestamp when the knowledge base was created.

file_countinteger

Number of files in the knowledge base.

ingestion_task_idsinteger[]

Ingestion tasks currently queued or running.

Changes

No recorded changes to this operation across all 1 revision of this API.