Skip to main content
POST
/
api
/
search
/
action
Quick action
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>",
  "locale": "en",
  "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>",
  "prompt_output_format": "<string>",
  "prompt_example_section": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Body

application/json
query
string
required
llm
string
required
chat_id
string
required
entry_id
string
required
use_case_id
string
required
thread_id
string
required
knowledge_asset_ids
string[]
required
quick_action_id
string
required
prompt_task
string
required
locale
string
default:en
is_initial_message
boolean | null
user_timezone
string | null
include_previous_entry_chunks
boolean
default:false
enable_filtering_in_search_pipeline
boolean | null
enable_splitting_in_search_pipeline
boolean | null
enable_reformulation_in_search_pipeline
boolean | null
targeted_web_search_urls
string[] | null
extracted_urls
string[] | null
top_n
integer | null
guided_search_fields
string | null
file_contents
string | null
prompt_output_format
string | null
prompt_example_section
string | null

Response

Successful Response