Create Query Token

post/knowledge-fs/spaces/{knowledge_base_id}/queries/admission

Request example

curl --request POST \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/queries/admission \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "mode": "fast",
  "query": "What changed in the refund policy this quarter?"
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/queries/admission"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "mode": "fast",
    "query": "What changed in the refund policy this quarter?"
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/queries/admission', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "mode": "fast",
    "query": "What changed in the refund policy this quarter?"
  })
});

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}/queries/admission',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "mode": "fast",
  "query": "What changed in the refund policy this quarter?"
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Content-Type: application/json',
  ],
]);

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

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/queries/admission"
	payload := strings.NewReader("{\n  \"mode\": \"fast\",\n  \"query\": \"What changed in the refund policy this quarter?\"\n}")

	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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}/queries/admission"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"mode\": \"fast\",\n  \"query\": \"What changed in the refund policy this quarter?\"\n}"))
    .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}/queries/admission')

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

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "mode": "fast",
  "query": "What changed in the refund policy this quarter?"
}'

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

Response

{
  "expires_at": "2026-09-06T08:31:07Z",
  "operation_id": "createQuery",
  "request": {
    "activeDocumentIds": [],
    "activeEntityIds": [],
    "knowledgeSpaceId": "8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f",
    "mode": "fast",
    "query": "What changed in the refund policy this quarter?"
  },
  "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Imtmcy0yMDI2LTA5In0.eyJpc3MiOiJkaWZ5LWNvbnRyb2wtcGxhbmUiLCJhdWQiOiJrbm93bGVkZ2UtZnMiLCJzdWIiOiJkaWZ5LWRhdGFzZXQtYXBpLWtleTo3YjRjOWUyMS0zZDVmLTRhNmItOGM3ZC05ZTBmMWEyYjNjNGQiLCJhY3Rpb24iOiJxdWVyaWVzLmNyZWF0ZSIsInRyYWNlX2lkIjoiM2YxZTlhN2MtMmI0ZC00ZTZmLThhOTAtMWIyYzNkNGU1ZjYwIiwiZXhwIjoxNzg4NjgzNDY3fQ.V2s9Rm5xR2ZUZ0J2M2Q5aW1KU3hqUXJsV1pKcGtnQUFCZUtGMQ",
  "trace_id": "3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60",
  "url": "https://api.example.com/v1/knowledge-fs/query-stream"
}

{
  "expires_at": "2026-09-06T08:33:52Z",
  "operation_id": "createQuery",
  "request": {
    "activeDocumentIds": [],
    "activeEntityIds": [],
    "knowledgeSpaceId": "8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f",
    "mode": "fast",
    "query": "What is the refund window for monthly plans?",
    "sessionId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
  },
  "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Imtmcy0yMDI2LTA5In0.eyJpc3MiOiJkaWZ5LWNvbnRyb2wtcGxhbmUiLCJhdWQiOiJrbm93bGVkZ2UtZnMiLCJzdWIiOiJkaWZ5LWRhdGFzZXQtYXBpLWtleTo3YjRjOWUyMS0zZDVmLTRhNmItOGM3ZC05ZTBmMWEyYjNjNGQiLCJhY3Rpb24iOiJxdWVyaWVzLmNyZWF0ZSIsInRyYWNlX2lkIjoiN2Q0YTFjOGUtNWY2MC00YjIzLTlhN2QtOGUwZjFhMmIzYzRkIiwiZXhwIjoxNzg4NjgzNjMyfQ.TnBHc0xxUjBkWWJ4M2VBaW1KU3hqUXJsV1pKcGtnQUFCZUtGMg",
  "trace_id": "7d4a1c8e-5f60-4b23-9a7d-8e0f1a2b3c4d",
  "url": "https://api.example.com/v1/knowledge-fs/query-stream"
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "query"
      ],
      "type": "string_too_long"
    }
  ]
}

{
  "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": "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_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

post/knowledge-fs/spaces/{knowledge_base_id}/queries/admission

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.

Body

application/json

activeDocumentIdsstring[]#

These IDs do not filter or rank retrieved content. Leave empty.

Items: max 100

activeEntityIdsstring[]#

These IDs do not filter or rank retrieved content. Leave empty.

Items: max 100

modeenum<string>#

Retrieval depth: fast, deep, or research (see Retrieval Depth). Omit it (or send null) to use the knowledge base's default depth, retrieval.default_mode in Get Knowledge Base Settings.

Options:fastdeepresearchnull

querystringrequired#

The question. Use a nonblank query. Also limited to 16,384 UTF-8 bytes.

Length: max 16000Pattern: \S

sessionIdstring#

ID of a query session, as a UUID. Omit it to start a new session. Run Query returns the session ID in its x-session-id response header.

A session stores the last 20 queries but doesn't carry them into later answers. It expires after 30 minutes without a query.

An expired or unknown ID starts a fresh session under that ID, so a UUID you generate yourself stays valid as that session's ID.

Responses

application/json

Query token issued.

expires_atstring#

When the token expires, as an ISO 8601 timestamp in UTC. At most 60 seconds after issue. The deployment can shorten the lifetime.

operation_idstring#

Always createQuery, the operation the token is valid for. Callers can ignore it.

requestobject#

Request body for Run Query. Send it unchanged.

Show child attributes

activeDocumentIdsstring[]#

The document IDs, as sent. [] when omitted.

activeEntityIdsstring[]#

The entity IDs, as sent. [] when omitted.

knowledgeSpaceIdstring#

Internal ID of the knowledge base. Not the knowledge base ID in the path. It is bound into the token, and Run Query rejects a body whose knowledgeSpaceId does not match the token.

modestring#

The retrieval depth, as sent. null when omitted.

querystring#

The question from your request. Can be null when the request contains image references.

Length: max 16000Pattern: \S

sessionIdstring#

The session ID, as sent. Absent when omitted.

tokenstring#

Query token for Run Query on this knowledge base, good until expires_at. Send it as Authorization: Bearer <token>.

Create a new token for each call, including a retry.

It is a signed JWT. Read trace_id from this response for the X-Trace-ID header; you do not need to decode the token.

trace_idstring#

Value to send as the X-Trace-ID header of Run Query. It equals the token's trace_id claim. It is not the query record ID.

urlstring#

Where to send Run Query. An absolute URL when the deployment sets SERVICE_API_URL. Otherwise the path /v1/knowledge-fs/query-stream, which already carries the /v1 prefix. Resolve that form against the scheme and host of your endpoint, not against the endpoint's path.

Submit Human Input Form Run Query