Get knowledge base - Sendora

GET

/

api

/

v1

/

public

/

knowledge-bases

/

{kb_id}

cURL

curl -X GET 'https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID' -H "X-API-Key: $SENDORA_API_KEY"

import requests

url = 'https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID", {
  method: "GET",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("GET", "https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID", nil)
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "chunk_count": 0,
  "description": "<string>",
  "is_company_default": false,
  "source_count": 0,
  "sources": [],
  "status": "ready",
  "used_by_agents": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Path Parameters

kb_id

string

required

The knowledge base's id: the id from List knowledge bases. It is also the last part of that page's address in the app.

Response

Successful Response

created_at

string<date-time>

required

Created at returned by the Sendora API.

id

string

required

The knowledge base's id. Pass it to any endpoint that takes kb_id.

name

string

required

Name returned by the Sendora API.

updated_at

string<date-time>

required

Updated at returned by the Sendora API.

chunk_count

integer

default:0

Chunk count returned by the Sendora API.

description

string | null

Description returned by the Sendora API.

is_company_default

boolean

default:false

Is company default returned by the Sendora API.

source_count

integer

default:0

Source count returned by the Sendora API.

sources

KBSourceOut · object[]

Sources returned by the Sendora API.

Show child attributes

status

string

default:ready

Status returned by the Sendora API.

used_by_agents

KBAgentUsage · object[]

Used by agents returned by the Sendora API.

Show child attributes

cURL

curl -X GET 'https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID' -H "X-API-Key: $SENDORA_API_KEY"

import requests

url = 'https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID", {
  method: "GET",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("GET", "https://api.sendora.ai/api/v1/public/knowledge-bases/YOUR_ID", nil)
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "chunk_count": 0,
  "description": "<string>",
  "is_company_default": false,
  "source_count": 0,
  "sources": [],
  "status": "ready",
  "used_by_agents": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}