GET
/
api
/
knowledgebases
curl --request GET \
  --url https://app.pathors.com/api/knowledgebases \
  --header 'x-api-key: <x-api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "embeddingModelName": "<string>",
  "chunkSize": 123,
  "chunkOverlap": 123
}

Get Knowledgebase

Retrieves knowledgebase associated with your project. Currently, each project is limited to one knowledgebase.

Endpoint

GET /api/knowledgebases

Headers

x-api-key
string
required

Your project API key for authentication

Response

Returns an array of knowledgebase objects. Due to current limitations, the array will contain at most one knowledgebase.

id
string

Unique identifier for the knowledgebase

name
string

Name of the knowledgebase

type
string

Type of the knowledgebase (currently only supports “pgvector”)

embeddingModelName
string

The embedding model used for the knowledgebase. One of:

  • text-embedding-ada-002
  • text-embedding-3-small
  • text-embedding-3-large
chunkSize
number

Maximum size of text chunks in characters

chunkOverlap
number

Number of overlapping characters between adjacent chunks

Example response:

[
  {
    "id": "kb_abc123",
    "name": "My Knowledge Base",
    "type": "pgvector",
    "embeddingModelName": "text-embedding-3-small",
    "chunkSize": 500,
    "chunkOverlap": 50
  }
]

Error Responses

Status CodeDescription
401No API key provided or invalid API key
500Internal server error

Implementation Notes

  • Currently limited to one knowledgebase per project
  • Uses server-side actions for data fetching

Example usage with fetch:

const response = await fetch('https://api.pathors.com/api/knowledgebases', {
  headers: {
    'x-api-key': 'your-api-key'
  }
});

const knowledgebases = await response.json();