/v1/knowledge/{kbId} (GET)

GET

/v1/knowledge/{kbId}

const url = 'https://service.testing.nairon.cloud/v1/knowledge/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://service.testing.nairon.cloud/v1/knowledge/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyHeader

Parameters

Path Parameters

kbId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

Responses

200

Default Response

application/json

object

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

projectId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

name

required

string

description

required

Any of:

string
null

string

status

required

string

Allowed values: active archived indexing

sources

required

Array<object>

object

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

name

required

string

type

required

string

Allowed values: website file

indexingStatus

required

string

Allowed values: idle completed inProgress

progress

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "status": "active",
  "sources": [
    {
      "type": "website",
      "indexingStatus": "idle"
    }
  ]
}