Skip to main content
POST
/
v1
/
knowledge-base
/
knowledge-bases
Create a knowledge base
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/knowledge-bases \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "metadata": {},
  "embedding_model": "<string>",
  "embedding_dimensions": 123,
  "chunk_size": 123,
  "chunk_overlap": 123,
  "retrieval_top_k": 123,
  "pdf_extraction_effort": "<string>",
  "default_sensitivity_level": 123
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "is_active": true,
  "document_count": 123,
  "embedding_model": "<string>",
  "embedding_dimensions": 123,
  "chunk_size": 123,
  "chunk_overlap": 123,
  "retrieval_top_k": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "default_sensitivity_level": 10,
  "processing_config": {},
  "pdf_extraction_effort": "low"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
description
string | null
metadata
Metadata · object
embedding_model
string | null
embedding_dimensions
integer | null
chunk_size
integer | null
chunk_overlap
integer | null
retrieval_top_k
integer | null
pdf_extraction_effort
string | null
Allowed value: "low"
default_sensitivity_level
integer | null

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
name
string
required
description
string | null
required
is_active
boolean
required
document_count
integer
required
embedding_model
string
required
embedding_dimensions
integer
required
chunk_size
integer
required
chunk_overlap
integer
required
retrieval_top_k
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
metadata
Metadata · object
default_sensitivity_level
integer
default:10
processing_config
Processing Config · object
pdf_extraction_effort
string
default:low