List Knowledge Bases

List all knowledge bases for the current tenant + service.

GET/knowledge-bases

Authorization

AuthorizationBearer token · headerrequired

Responses

200

Successful Response

Array of KnowledgeBaseResponse

_idstringrequired

namestringrequired

job_typeapp__models__api__agents_api_models__flink_jobs__FlinkJobTypeEnumrequired

Allowed:pyflinkjaragent_configknowledge_base

statusFlinkJobStatusEnumrequired

Allowed:CREATEDDEPLOYINGRUNNINGCANCELLINGCANCELLEDFAILEDFINISHED

desired_statusFlinkJobStatusEnum | null

Show properties

Any of:

FlinkJobStatusEnum

string

null

null

flink_job_namestringrequired

flink_job_idstring | null

Show properties

Any of:

string

string

null

null

parallelisminteger

default: 1

error_messagestring | null

Show properties

Any of:

string

string

null

null

agent_configobject | null

KB config (secrets masked)

Show properties

Any of:

object

object

null

null

created_bystring | null

Show properties

Any of:

string

string

null

null

created_timestampstring<date-time> | null

Show properties

Any of:

string<date-time>

string<date-time>

null

null

updated_timestampstring<date-time> | null

Show properties

Any of:

string<date-time>

string<date-time>

null

null

Request

curl -X GET 'https://api.streamkap.com/knowledge-bases' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.streamkap.com/knowledge-bases", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/knowledge-bases",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

[
  {
    "_id": "string",
    "name": "string",
    "job_type": "pyflink",
    "status": "CREATED",
    "desired_status": "CREATED",
    "flink_job_name": "string",
    "flink_job_id": "string",
    "parallelism": 1,
    "error_message": "string",
    "agent_config": {},
    "created_by": "string",
    "created_timestamp": "2019-08-24T14:15:22Z",
    "updated_timestamp": "2019-08-24T14:15:22Z"
  }
]