Get Knowledge Base Settings

GET

knowledge-fs

spaces

{knowledge_base_id}

settings

Get Knowledge Base Settings

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings', 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_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings",
  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_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings")

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

{
  "active_profile_available": false,
  "active_profile_revisions": {
    "embedding": null,
    "retrieval": null
  },
  "capabilities": {
    "deep": false,
    "index": false,
    "ingest": false,
    "query": false,
    "research": false,
    "source_sync": false
  },
  "configuration_state": "setup-required",
  "embedding": null,
  "issues": [
    {
      "code": "missing",
      "field": "embedding",
      "retryable": false
    },
    {
      "code": "missing",
      "field": "reasoning",
      "retryable": false
    },
    {
      "code": "missing",
      "field": "rerank",
      "retryable": false
    }
  ],
  "retrieval": null,
  "revision": 1
}

Authorizations

Authorization

string

header

required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

knowledge_base_id

string<uuid>

required

Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's API Access dialog (…/knowledge-fs/spaces/<knowledge base ID>), and the segment after /datasets/new/ in the address bar.

Response

The knowledge base's settings.

active_profile_available

boolean

true when both an embedding model and retrieval settings are live, which happens after the first document is indexed.

active_profile_revisions

object

Revisions of the live models. Each is null until the first document is indexed. Once a profile is active, a change through Update Knowledge Base Settings runs as a migration.

Show child attributes

capabilities

object

Readiness of the published settings. Three flags stand for retrieval depths, with query standing for fast.

To check readiness for a specific depth, send that depth explicitly as mode and check its flag. Do not use a pending retrieval.default_mode to identify the depth of a query that omits mode.

Show child attributes

configuration_state

string

active when an embedding model and complete retrieval settings (with an enabled rerank model) are stored. setup-required when either is missing. validation-failed when the pending settings failed validation while the first document was indexed. issues names the settings that failed.

embedding

object | null

Embedding model. The pending selection when one is stored, otherwise the live model. A pending selection can differ from the model queries use now. null when none is set.

Its dimension, revision, and vector_space_id are informational, and no operation takes them.

Show child attributes

issues

object[]

What keeps the knowledge base from being ready. Empty when nothing does.

Show child attributes

retrieval

object | null

Retrieval settings. The pending selection when one is stored, otherwise the live settings. A pending selection can differ from the settings queries use now. null when none is set.

Show child attributes

revision

integer

Settings revision. Send it as expectedRevision in Update Knowledge Base Settings. The other revision fields in this response are not that value.

Get Knowledge Base Settings

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings', 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_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings",
  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_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings")

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

{
  "active_profile_available": false,
  "active_profile_revisions": {
    "embedding": null,
    "retrieval": null
  },
  "capabilities": {
    "deep": false,
    "index": false,
    "ingest": false,
    "query": false,
    "research": false,
    "source_sync": false
  },
  "configuration_state": "setup-required",
  "embedding": null,
  "issues": [
    {
      "code": "missing",
      "field": "embedding",
      "retryable": false
    },
    {
      "code": "missing",
      "field": "reasoning",
      "retryable": false
    },
    {
      "code": "missing",
      "field": "rerank",
      "retryable": false
    }
  ],
  "retrieval": null,
  "revision": 1
}

Guides

App APIs

Knowledge APIs

Get Knowledge Base Settings

Authorizations

Path Parameters

Response