Skip to main content
POST
Semantic search within a knowledge collection

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Headers

x-username
string
default:(project default user)

External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.

Path Parameters

id
string
required

Collection ID

Example:

"755ab29c-2864-5cfd-9c2b-4953f7314b21"

Body

application/json
query
string
required

Semantic search query

Minimum string length: 1
Example:

"refund policy"

limit
number
default:5

Max results (1-20)

Required range: 1 <= x <= 20
Example:

5

Response

200 - application/json

Search completed

success
boolean
required

Success status

Example:

true

message
string
required

Success message

Example:

"Operation completed successfully"

data
object
required
Example: