Skip to main content
POST
/
users
/
{user_id}
/
search
Search User Docs
curl --request POST \
  --url http://api/users/{user_id}/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 10,
  "metadata_filter": {},
  "include_embeddings": true,
  "text": "<string>",
  "lang": "en-US",
  "trigram_similarity_threshold": 0.5
}
'
{
  "docs": [
    {
      "metadata": {},
      "owner": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "role": "user"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "snippet": {
        "index": 123,
        "content": "<string>",
        "embedding": [
          123
        ]
      },
      "distance": 123
    }
  ],
  "time": 123
}

Authorizations

Authorization
string
header
required

Path Parameters

user_id
string<uuid>
required

Query Parameters

connection_pool
any

Body

application/json
  • TextOnlyDocSearchRequest
  • VectorDocSearchRequest
  • HybridDocSearchRequest
text
string
required
limit
integer
default:10
Required range: 1 <= x <= 50
metadata_filter
object
include_embeddings
boolean
default:true
lang
string
default:en-US
trigram_similarity_threshold
number | null
Required range: 0 <= x <= 1

Response

Successful Response

docs
DocReference · object[]
required
time
number
required
Required range: x > 0