Search for similar chunks

POST /api/v1/knowledge-base/search — request parameters and responses from the Menace Voice API schema.

2 min read

post/api/v1/knowledge-base/search

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/knowledge-base/search \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "limit": 5,
  "document_uuids": [
    "<string>"
  ],
  "min_similarity": 0
}'

Response

{
  "chunks": [
    {
      "id": 1,
      "document_id": 1,
      "chunk_text": "<string>",
      "contextualized_text": "<string>",
      "chunk_index": 1,
      "chunk_metadata": {},
      "filename": "<string>",
      "document_uuid": "<string>",
      "similarity": 1
    }
  ],
  "query": "<string>",
  "total_results": 1
}

post/api/v1/knowledge-base/search

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

querystringrequired#

Search query text

limitinteger#

Maximum number of results

Default: 5

Range: 1–50

document_uuidsstring[] · null#

Filter by specific document UUIDs

Show child attributes

Any of

min_similaritynumber · null#

Minimum similarity threshold

Show child attributes

Any of

Responses

application/json

Successful Response

chunksobject[]required#

Show child attributes

idintegerrequired#

document_idintegerrequired#

chunk_textstringrequired#

contextualized_textstring · nullrequired#

Show child attributes

Any of

chunk_indexintegerrequired#

chunk_metadataobjectrequired#

filenamestringrequired#

document_uuidstringrequired#

similaritynumberrequired#

querystringrequired#

total_resultsintegerrequired#

Delete document List Node Types