Search context and generate an LLM-powered answer
This endpoint performs a context search using the context processor, joins all matching context chunks into a single string, then sends that joined context along with the user's query to an LLM to produce a natural-language answer grounded in the retrieved context.
By default the response only includes the generated answer. Pass
?context=true to also receive the joined context string that was used to
ground the answer.
Authorization
bearerAuth In: header
Query Parameters
Controls the search mode:
- mode=fast -> prioritizes speed over completeness.
- mode=standard -> performs a comprehensive search (default if omitted).
"standard"Value in
- "fast"
- "standard"
When set to true, the response includes the joined context string used
to ground the answer. Defaults to false (only answer,and
usage are returned).
falseRequest Body
application/json
The ID of the user making the request
The steering prompt for the query - basically the way in which you want to get your answer as.
The search query and question to be answered using retrieved context
Maximum similarity threshold (must be >= minimum_similarity_threshold)
0 <= value <= 1Minimum similarity threshold
0 <= value <= 1Search scope
"internal"Value in
- "internal"
- "external"
Additional metadata for the search
{}Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/context/search/steer" \ -H "Content-Type: application/json" \ -d '{ "query": "What did the customer ask about pricing for the Scale plan?", "similarity_threshold": 0.8, "minimum_similarity_threshold": 0.5, "scope": "internal" }'{ "answer": "string", "context": "string", "usage": { "inputTokens": 0, "outputTokens": 0, "totalTokens": 0 }}