Skip to content

Semantic Search Query

POST
/api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/query

Performs semantic search on a collection using vector similarity. Returns the most relevant documents based on meaning, not keyword matching. * * Use Cases: * - Find relevant documentation for user questions * - Power RAG (Retrieval Augmented Generation) in AI assistants * - Semantic search across knowledge bases

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

collectionId
required
string format: uuid

The collection ID

Request Body required

object
query
required

Natural language search query

string
How do I authenticate with the API?
count

Number of results to return

integer
default: 5 >= 1 <= 20

Responses

200

Search completed successfully

object
results
Array<object>
object
content
string
score
number format: float
metadata
object
title
string
source_url
string
section
string
query
string
count
integer
executionTimeMs
integer

400

Invalid request parameters

403

Access denied

404

Collection not found

500

Failed to perform search