Knowledge Bases

Create a knowledge base

Creates an empty knowledge base. Add files to it with Generate a file upload URL followed by Ingest uploaded files.

post/knowledge-bases

Request

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

Request body

namestring required

Name for the knowledge base. Must be unique among your knowledge bases.

descriptionstring nullable

Optional description of what the knowledge base holds.

Response

The knowledge base was created.

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.

ingestion_task_idsinteger[]

Ingestion tasks queued for this knowledge base. Empty on creation.

Changes

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