curl --request POST \
--url https://platform-backend.getalchemystai.com/api/v1/context/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "What did the customer ask about pricing for the Scale plan?",
"similarity_threshold": 0.8,
"minimum_similarity_threshold": 0.5,
"scope": "internal"
}
'{
"contexts": [
{
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {},
"content": "<string>",
"score": 1.001
}
]
}{
"response": "Fields missing. Detailed error: {error details}"
}{
"success": false,
"error": "Error details",
"message": "Invalid job id",
"status": 400,
"statusText": "<string>"
}{
"success": false,
"error": "Error details",
"message": "Invalid job id",
"status": 400,
"statusText": "<string>"
}{
"success": false,
"error": "Error details",
"message": "Invalid job id",
"status": 400,
"statusText": "<string>"
}{
"response": "error"
}Search for context data in the context processor
This endpoint sends a search request to the context processor to retrieve relevant context data based on the provided query.
curl --request POST \
--url https://platform-backend.getalchemystai.com/api/v1/context/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "What did the customer ask about pricing for the Scale plan?",
"similarity_threshold": 0.8,
"minimum_similarity_threshold": 0.5,
"scope": "internal"
}
'{
"contexts": [
{
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {},
"content": "<string>",
"score": 1.001
}
]
}{
"response": "Fields missing. Detailed error: {error details}"
}{
"success": false,
"error": "Error details",
"message": "Invalid job id",
"status": 400,
"statusText": "<string>"
}{
"success": false,
"error": "Error details",
"message": "Invalid job id",
"status": 400,
"statusText": "<string>"
}{
"success": false,
"error": "Error details",
"message": "Invalid job id",
"status": 400,
"statusText": "<string>"
}{
"response": "error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Controls whether metadata is included in the response:
- metadata=true → metadata will be included in each context item in the response.
- metadata=false (or omitted) → metadata will be excluded from the response for better performance.
true, false Controls the search mode:
- mode=fast → prioritizes speed over completeness.
- mode=standard → performs a comprehensive search (default if omitted).
fast, standard Body
The search query used to search for context data
"search query for user preferences"
Maximum similarity threshold (must be >= minimum_similarity_threshold)
0 <= x <= 10.8
Minimum similarity threshold
0 <= x <= 10.5
The ID of the user making the request
"user123"
Search scope
internal, external Additional metadata for the search
Response
Context search request successfully processed. Response structure varies based on metadata query parameter: if metadata=true, each context includes metadata; if metadata=false or omitted, metadata is excluded from the response.
Show child attributes
Show child attributes