curl --request POST \
--url https://api.example.com/api/search/action \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"llm": "<string>",
"chat_id": "<string>",
"entry_id": "<string>",
"use_case_id": "<string>",
"thread_id": "<string>",
"knowledge_asset_ids": [
"<string>"
],
"quick_action_id": "<string>",
"prompt_task": "<string>",
"is_initial_message": true,
"user_timezone": "<string>",
"include_previous_entry_chunks": false,
"enable_filtering_in_search_pipeline": true,
"enable_splitting_in_search_pipeline": true,
"enable_reformulation_in_search_pipeline": true,
"targeted_web_search_urls": [
"<string>"
],
"extracted_urls": [
"<string>"
],
"top_n": 123,
"guided_search_fields": "<string>",
"file_contents": "<string>",
"pro_search_mode": false,
"response_format": null,
"prompt_output_format": "<string>",
"prompt_example_section": "<string>"
}
'import requests
url = "https://api.example.com/api/search/action"
payload = {
"query": "<string>",
"llm": "<string>",
"chat_id": "<string>",
"entry_id": "<string>",
"use_case_id": "<string>",
"thread_id": "<string>",
"knowledge_asset_ids": ["<string>"],
"quick_action_id": "<string>",
"prompt_task": "<string>",
"is_initial_message": True,
"user_timezone": "<string>",
"include_previous_entry_chunks": False,
"enable_filtering_in_search_pipeline": True,
"enable_splitting_in_search_pipeline": True,
"enable_reformulation_in_search_pipeline": True,
"targeted_web_search_urls": ["<string>"],
"extracted_urls": ["<string>"],
"top_n": 123,
"guided_search_fields": "<string>",
"file_contents": "<string>",
"pro_search_mode": False,
"response_format": None,
"prompt_output_format": "<string>",
"prompt_example_section": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
llm: '<string>',
chat_id: '<string>',
entry_id: '<string>',
use_case_id: '<string>',
thread_id: '<string>',
knowledge_asset_ids: ['<string>'],
quick_action_id: '<string>',
prompt_task: '<string>',
is_initial_message: true,
user_timezone: '<string>',
include_previous_entry_chunks: false,
enable_filtering_in_search_pipeline: true,
enable_splitting_in_search_pipeline: true,
enable_reformulation_in_search_pipeline: true,
targeted_web_search_urls: ['<string>'],
extracted_urls: ['<string>'],
top_n: 123,
guided_search_fields: '<string>',
file_contents: '<string>',
pro_search_mode: false,
response_format: null,
prompt_output_format: '<string>',
prompt_example_section: '<string>'
})
};
fetch('https://api.example.com/api/search/action', 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.example.com/api/search/action",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'llm' => '<string>',
'chat_id' => '<string>',
'entry_id' => '<string>',
'use_case_id' => '<string>',
'thread_id' => '<string>',
'knowledge_asset_ids' => [
'<string>'
],
'quick_action_id' => '<string>',
'prompt_task' => '<string>',
'is_initial_message' => true,
'user_timezone' => '<string>',
'include_previous_entry_chunks' => false,
'enable_filtering_in_search_pipeline' => true,
'enable_splitting_in_search_pipeline' => true,
'enable_reformulation_in_search_pipeline' => true,
'targeted_web_search_urls' => [
'<string>'
],
'extracted_urls' => [
'<string>'
],
'top_n' => 123,
'guided_search_fields' => '<string>',
'file_contents' => '<string>',
'pro_search_mode' => false,
'response_format' => null,
'prompt_output_format' => '<string>',
'prompt_example_section' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/search/action"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"llm\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"entry_id\": \"<string>\",\n \"use_case_id\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"knowledge_asset_ids\": [\n \"<string>\"\n ],\n \"quick_action_id\": \"<string>\",\n \"prompt_task\": \"<string>\",\n \"is_initial_message\": true,\n \"user_timezone\": \"<string>\",\n \"include_previous_entry_chunks\": false,\n \"enable_filtering_in_search_pipeline\": true,\n \"enable_splitting_in_search_pipeline\": true,\n \"enable_reformulation_in_search_pipeline\": true,\n \"targeted_web_search_urls\": [\n \"<string>\"\n ],\n \"extracted_urls\": [\n \"<string>\"\n ],\n \"top_n\": 123,\n \"guided_search_fields\": \"<string>\",\n \"file_contents\": \"<string>\",\n \"pro_search_mode\": false,\n \"response_format\": null,\n \"prompt_output_format\": \"<string>\",\n \"prompt_example_section\": \"<string>\"\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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/search/action")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"llm\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"entry_id\": \"<string>\",\n \"use_case_id\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"knowledge_asset_ids\": [\n \"<string>\"\n ],\n \"quick_action_id\": \"<string>\",\n \"prompt_task\": \"<string>\",\n \"is_initial_message\": true,\n \"user_timezone\": \"<string>\",\n \"include_previous_entry_chunks\": false,\n \"enable_filtering_in_search_pipeline\": true,\n \"enable_splitting_in_search_pipeline\": true,\n \"enable_reformulation_in_search_pipeline\": true,\n \"targeted_web_search_urls\": [\n \"<string>\"\n ],\n \"extracted_urls\": [\n \"<string>\"\n ],\n \"top_n\": 123,\n \"guided_search_fields\": \"<string>\",\n \"file_contents\": \"<string>\",\n \"pro_search_mode\": false,\n \"response_format\": null,\n \"prompt_output_format\": \"<string>\",\n \"prompt_example_section\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/search/action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"llm\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"entry_id\": \"<string>\",\n \"use_case_id\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"knowledge_asset_ids\": [\n \"<string>\"\n ],\n \"quick_action_id\": \"<string>\",\n \"prompt_task\": \"<string>\",\n \"is_initial_message\": true,\n \"user_timezone\": \"<string>\",\n \"include_previous_entry_chunks\": false,\n \"enable_filtering_in_search_pipeline\": true,\n \"enable_splitting_in_search_pipeline\": true,\n \"enable_reformulation_in_search_pipeline\": true,\n \"targeted_web_search_urls\": [\n \"<string>\"\n ],\n \"extracted_urls\": [\n \"<string>\"\n ],\n \"top_n\": 123,\n \"guided_search_fields\": \"<string>\",\n \"file_contents\": \"<string>\",\n \"pro_search_mode\": false,\n \"response_format\": null,\n \"prompt_output_format\": \"<string>\",\n \"prompt_example_section\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Quick action
SSE endpoint for quick action processing that streams responses using Server-Sent Events
curl --request POST \
--url https://api.example.com/api/search/action \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"llm": "<string>",
"chat_id": "<string>",
"entry_id": "<string>",
"use_case_id": "<string>",
"thread_id": "<string>",
"knowledge_asset_ids": [
"<string>"
],
"quick_action_id": "<string>",
"prompt_task": "<string>",
"is_initial_message": true,
"user_timezone": "<string>",
"include_previous_entry_chunks": false,
"enable_filtering_in_search_pipeline": true,
"enable_splitting_in_search_pipeline": true,
"enable_reformulation_in_search_pipeline": true,
"targeted_web_search_urls": [
"<string>"
],
"extracted_urls": [
"<string>"
],
"top_n": 123,
"guided_search_fields": "<string>",
"file_contents": "<string>",
"pro_search_mode": false,
"response_format": null,
"prompt_output_format": "<string>",
"prompt_example_section": "<string>"
}
'import requests
url = "https://api.example.com/api/search/action"
payload = {
"query": "<string>",
"llm": "<string>",
"chat_id": "<string>",
"entry_id": "<string>",
"use_case_id": "<string>",
"thread_id": "<string>",
"knowledge_asset_ids": ["<string>"],
"quick_action_id": "<string>",
"prompt_task": "<string>",
"is_initial_message": True,
"user_timezone": "<string>",
"include_previous_entry_chunks": False,
"enable_filtering_in_search_pipeline": True,
"enable_splitting_in_search_pipeline": True,
"enable_reformulation_in_search_pipeline": True,
"targeted_web_search_urls": ["<string>"],
"extracted_urls": ["<string>"],
"top_n": 123,
"guided_search_fields": "<string>",
"file_contents": "<string>",
"pro_search_mode": False,
"response_format": None,
"prompt_output_format": "<string>",
"prompt_example_section": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
llm: '<string>',
chat_id: '<string>',
entry_id: '<string>',
use_case_id: '<string>',
thread_id: '<string>',
knowledge_asset_ids: ['<string>'],
quick_action_id: '<string>',
prompt_task: '<string>',
is_initial_message: true,
user_timezone: '<string>',
include_previous_entry_chunks: false,
enable_filtering_in_search_pipeline: true,
enable_splitting_in_search_pipeline: true,
enable_reformulation_in_search_pipeline: true,
targeted_web_search_urls: ['<string>'],
extracted_urls: ['<string>'],
top_n: 123,
guided_search_fields: '<string>',
file_contents: '<string>',
pro_search_mode: false,
response_format: null,
prompt_output_format: '<string>',
prompt_example_section: '<string>'
})
};
fetch('https://api.example.com/api/search/action', 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.example.com/api/search/action",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'llm' => '<string>',
'chat_id' => '<string>',
'entry_id' => '<string>',
'use_case_id' => '<string>',
'thread_id' => '<string>',
'knowledge_asset_ids' => [
'<string>'
],
'quick_action_id' => '<string>',
'prompt_task' => '<string>',
'is_initial_message' => true,
'user_timezone' => '<string>',
'include_previous_entry_chunks' => false,
'enable_filtering_in_search_pipeline' => true,
'enable_splitting_in_search_pipeline' => true,
'enable_reformulation_in_search_pipeline' => true,
'targeted_web_search_urls' => [
'<string>'
],
'extracted_urls' => [
'<string>'
],
'top_n' => 123,
'guided_search_fields' => '<string>',
'file_contents' => '<string>',
'pro_search_mode' => false,
'response_format' => null,
'prompt_output_format' => '<string>',
'prompt_example_section' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/search/action"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"llm\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"entry_id\": \"<string>\",\n \"use_case_id\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"knowledge_asset_ids\": [\n \"<string>\"\n ],\n \"quick_action_id\": \"<string>\",\n \"prompt_task\": \"<string>\",\n \"is_initial_message\": true,\n \"user_timezone\": \"<string>\",\n \"include_previous_entry_chunks\": false,\n \"enable_filtering_in_search_pipeline\": true,\n \"enable_splitting_in_search_pipeline\": true,\n \"enable_reformulation_in_search_pipeline\": true,\n \"targeted_web_search_urls\": [\n \"<string>\"\n ],\n \"extracted_urls\": [\n \"<string>\"\n ],\n \"top_n\": 123,\n \"guided_search_fields\": \"<string>\",\n \"file_contents\": \"<string>\",\n \"pro_search_mode\": false,\n \"response_format\": null,\n \"prompt_output_format\": \"<string>\",\n \"prompt_example_section\": \"<string>\"\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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/search/action")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"llm\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"entry_id\": \"<string>\",\n \"use_case_id\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"knowledge_asset_ids\": [\n \"<string>\"\n ],\n \"quick_action_id\": \"<string>\",\n \"prompt_task\": \"<string>\",\n \"is_initial_message\": true,\n \"user_timezone\": \"<string>\",\n \"include_previous_entry_chunks\": false,\n \"enable_filtering_in_search_pipeline\": true,\n \"enable_splitting_in_search_pipeline\": true,\n \"enable_reformulation_in_search_pipeline\": true,\n \"targeted_web_search_urls\": [\n \"<string>\"\n ],\n \"extracted_urls\": [\n \"<string>\"\n ],\n \"top_n\": 123,\n \"guided_search_fields\": \"<string>\",\n \"file_contents\": \"<string>\",\n \"pro_search_mode\": false,\n \"response_format\": null,\n \"prompt_output_format\": \"<string>\",\n \"prompt_example_section\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/search/action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"llm\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"entry_id\": \"<string>\",\n \"use_case_id\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"knowledge_asset_ids\": [\n \"<string>\"\n ],\n \"quick_action_id\": \"<string>\",\n \"prompt_task\": \"<string>\",\n \"is_initial_message\": true,\n \"user_timezone\": \"<string>\",\n \"include_previous_entry_chunks\": false,\n \"enable_filtering_in_search_pipeline\": true,\n \"enable_splitting_in_search_pipeline\": true,\n \"enable_reformulation_in_search_pipeline\": true,\n \"targeted_web_search_urls\": [\n \"<string>\"\n ],\n \"extracted_urls\": [\n \"<string>\"\n ],\n \"top_n\": 123,\n \"guided_search_fields\": \"<string>\",\n \"file_contents\": \"<string>\",\n \"pro_search_mode\": false,\n \"response_format\": null,\n \"prompt_output_format\": \"<string>\",\n \"prompt_example_section\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer token authentication. Format: 'Bearer '
Body
The user's message to the assistant. Server-side normalization may adjust curly braces in the text. For document chat, images already linked to the chat are appended to the prompt automatically.
Chat model identifier (matched case-insensitively; stored lowercase). Must be enabled for your deployment—use the Genow models API to list valid chat_model_name values (e.g. Gemini Pro is often exposed as gemini-2.5-pro via LiteLLM; exact ids depend on your tenant configuration).
Identifier of the conversation. The server creates the chat on first use if it does not exist yet. Document context is whatever is attached to this chat in Genow (uploaded files).
Client-generated unique id for this question/answer turn. It is persisted with the stored chat entry and should be unique within the chat.
Optional locale (ISO 639-1 code) for system prompt and templating, e.g. en or de. Omit to use server defaults.
bg, cs, da, de, el, en, es, et, fi, fr, hr, hu, is, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sr, sv, tr, zh Optional hint that this is the first user message in a new chat (used by Genow clients for titling and analytics). Document chat retrieval does not depend on this flag.
Optional IANA timezone name (e.g. Europe/Berlin, America/New_York) used to inject the current local date/time into the system prompt.
Response
Successful Response
Was this page helpful?

