Skip to main content
POST
/
api
/
search
Search documents
curl --request POST \
  --url https://api.example.com/api/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "search_query_operator": "<string>",
  "knowledge_asset_ids": [
    "<string>"
  ],
  "use_case_id": "<string>",
  "locale": "en",
  "num_results": 5,
  "enable_splitting_in_search_pipeline": true,
  "enable_reformulation_in_search_pipeline": true,
  "evaluation_prompts": [
    {
      "key": "likelihood",
      "value": "",
      "mode": "separately"
    }
  ]
}
'
{
  "documents": [
    {
      "page_content": "<string>",
      "metadata": {}
    }
  ],
  "metadata": {
    "query": "<string>",
    "knowledge_asset_ids": [
      "<string>"
    ],
    "split_subtasks": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Body

application/json

Schema for document search requests that don't need chat context

query
string
required
search_query_operator
string
required
knowledge_asset_ids
string[]
required
use_case_id
string
required
locale
string
default:en
num_results
integer
default:5
enable_splitting_in_search_pipeline
boolean | null
enable_reformulation_in_search_pipeline
boolean | null
evaluation_prompts
EvaluationPrompt · object[] | null

Response

Successful Response

Response schema for document search endpoint.

documents
DocumentSearchResult · object[]
required
metadata
SearchDocumentsMetadata · object
required

Metadata schema for search documents response.