Skip to main content
POST
/
api
/
v1
/
knowledge
/
retrieve
Retrieve knowledge context
curl --request POST \
  --url http://127.0.0.1:4000/api/v1/knowledge/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "topK": 25,
  "minScore": 0,
  "projectId": "<string>",
  "documentId": "<string>"
}
'
{
  "query": "<string>",
  "topK": 123,
  "items": [
    {
      "id": "<string>",
      "score": 123,
      "model": "<string>",
      "documentId": "<string>",
      "documentName": "<string>",
      "projectId": "<string>",
      "source": "<string>",
      "chunkIndex": 123,
      "sectionPath": "<string>",
      "page": 123,
      "content": "<string>",
      "metadata": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://familyco.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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
Minimum string length: 1
​
topK
integer
Required range: 1 <= x <= 50
​
minScore
number
Required range: -1 <= x <= 1
​
projectId
string
Minimum string length: 1
​
documentId
string
Minimum string length: 1

Response

Retrieval result

​
query
string
required
​
topK
integer
required
​
items
object[]
required