Skip to main content
POST
/
api
/
v1
/
context
/
search
{
  "contexts": [
    {
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "content": "<string>",
      "score": 1.001
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
query
string
required

The search query used to search for context data

Example:

"search query for user preferences"

​
similarity_threshold
number
required

Maximum similarity threshold (must be >= minimum_similarity_threshold)

Required range: 0 <= x <= 1
Example:

0.8

​
minimum_similarity_threshold
number
required

Minimum similarity threshold

Required range: 0 <= x <= 1
Example:

0.5

​
user_id
string

The ID of the user making the request

Example:

"user123"

​
scope
enum<string>
default:internal

Search scope

Available options:
internal,
external
​
metadata
object

Additional metadata for the search

Response

Context search request successfully processed

​
contexts
object[]