Skip to main content
GET
/
api
/
knowledge-bases
/
{knowledgeBaseId}
Get knowledge base
curl --request GET \
  --url https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.upon-ai.com/api/knowledge-bases/{knowledgeBaseId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "knowledgeBaseId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "sources": [
    {
      "source_id": "<string>",
      "source_type": "<string>",
      "filename": "<string>"
    }
  ],
  "workspaceId": 123
}

Authorizations

Authorization
string
header
required

Generate tokens from your profile settings at app.uponai.com.

Path Parameters

knowledgeBaseId
string
required

Knowledge base identifier.

Query Parameters

workspaceId
integer
required

Workspace identifier. Call GET /api/workspaces to list workspaces accessible to your token.

Response

200 - application/json

Knowledge base details.

knowledgeBaseId
string
required
name
string
required
status
enum<string>
required
Available options:
processing,
ready,
failed
description
string | null
sources
object[]
workspaceId
integer | null