Skip to main content
POST
/
conventions
/
search
Search Conventions
curl --request POST \
  --url https://api.example.com/conventions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_text": "<string>",
  "top_k": 20
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "content": "<string>",
    "similarity_score": 123
  }
]

Authorizations

​
Authorization
string
header
required

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

Headers

​
Api-key
string | null

Query Parameters

​
private_member_id
string

Body

application/json
​
search_text
string
required
​
top_k
integer
default:20

Response

Successful Response

​
id
string<uuid>
required
​
title
string
required
​
content
string
required
​
similarity_score
integer
required