Get Knowledge Base Settings

get/knowledge-fs/spaces/{knowledge_base_id}/settings

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

response = http.request(request)
puts response.read_body

Response

{
  "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
}

{
  "active_profile_available": true,
  "active_profile_revisions": {
    "embedding": 2,
    "retrieval": 3
  },
  "capabilities": {
    "deep": true,
    "index": true,
    "ingest": true,
    "query": true,
    "research": true,
    "source_sync": true
  },
  "configuration_state": "active",
  "embedding": {
    "dimension": 1536,
    "model": "text-embedding-3-small",
    "plugin_id": "langgenius/openai",
    "provider": "openai",
    "revision": 2,
    "vector_space_id": "embedding-space-sha256:4f7c2d9a1b3e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4"
  },
  "issues": [],
  "retrieval": {
    "default_mode": "fast",
    "reasoning_model": {
      "dimension": null,
      "model": "gpt-4.1-mini",
      "plugin_id": "langgenius/openai",
      "provider": "openai",
      "revision": null,
      "vector_space_id": null
    },
    "rerank": {
      "enabled": true,
      "model": {
        "model": "rerank-v3.5",
        "pluginId": "langgenius/cohere",
        "provider": "cohere"
      }
    },
    "revision": 3,
    "score_threshold": {
      "enabled": false,
      "stage": "mode-final",
      "value": null
    },
    "top_k": 10
  },
  "revision": 7
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Authorization header must be provided and start with 'Bearer'",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/settings

Authorization

Authorizationstringheaderrequired#

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_idstringrequired#

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.

Responses

application/json

The knowledge base's settings.

active_profile_availableboolean#

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

active_profile_revisionsobject#

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

embeddinginteger#

Revision of the live embedding model.

retrievalinteger#

Revision of the live retrieval settings.

capabilitiesobject#

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

deepboolean#

Queries at deep depth can run.

indexboolean#

Documents can be indexed. The models are live.

ingestboolean#

Documents can be added. The models are live, or complete pending settings are ready to be activated by the first document.

queryboolean#

Queries at fast depth can run.

researchboolean#

Queries at research depth can run.

source_syncboolean#

Sources can sync. Same condition as ingest.

configuration_statestring#

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.

embeddingobject#

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

dimensioninteger#

Vector dimension, observed when the model is first used. null until the model is live.

modelstring#

Model name.

plugin_idstring#

Plugin that provides the model, as organization/plugin_name.

providerstring#

Provider name inside the plugin.

revisioninteger#

Revision of the live embedding model. null until the model is live.

vector_space_idstring#

Identifies where the model's vectors are stored. null until the model is live.

issuesobject[]#

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

Show child attributes

codestring#

What is wrong with the setting:

missing: the selection is absent, or rerank is disabled.
validation_failed, unavailable, or incompatible: the pending settings failed validation. For incompatible, check the model's supported task, embedding dimension, and whether the provider returned the selected model.
binding_missing: the published content is not ready to use the configured models. Check indexing progress in Dify.
unavailable on publication: the published content is not ready for every depth.

fieldstring#

The setting concerned: embedding, reasoning, rerank, or publication (the published content).

retryableboolean#

Whether waiting and retrying can clear the issue without a settings change.

retrievalobject#

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

default_modestring#

Default depth in the returned retrieval settings: fast, deep, or research. When a query omits mode, it uses the published default, which can differ from this value if pending settings are returned.

reasoning_modelobject#

System reasoning model. Its dimension, revision, and vector_space_id are always null.

Show child attributes

dimensioninteger#

Always null.

modelstring#

Model name.

plugin_idstring#

Plugin that provides the model, as organization/plugin_name.

providerstring#

Provider name inside the plugin.

revisioninteger#

Always null.

vector_space_idstring#

Always null.

rerankobject#

Rerank model. Its model object uses the camelCase key pluginId, unlike the rest of this response.

Show child attributes

enabledboolean#

Whether retrieved chunks are reranked.

modelobject#

Rerank model selection. null when no rerank model is set.

Show child attributes

modelstring#

Model name.

pluginIdstring#

Plugin that provides the model, as organization/plugin_name.

providerstring#

Provider name inside the plugin.

revisioninteger#

Revision of the live retrieval settings. null while the settings are pending.

score_thresholdobject#

Score cutoff that drops low-scoring chunks.

Show child attributes

enabledboolean#

Whether the cutoff applies.

stagestring#

Where the cutoff applies. mode-final applies it to the final score of the depth that runs: the rerank score at fast and deep, the PageIndex score at research. rerank is the same thing under its old name.

valuenumber#

The cutoff score, 0 to 1. null when not set.

top_kinteger#

Maximum number of chunks each search returns.

revisioninteger#

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

Retry Source Run Update Knowledge Base Settings