Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

agentId
string
required

The agent this resource is scoped to (the UUID returned by createAgent / listAgents).

Body

application/json
query
string
required

The test question to retrieve against.

sourceIds
string[]

Optional — limit the search to these knowledge source ids. Omit to search all.

Response

Preview chunks + top score.

success
boolean
required
data
object
required
message
string
errors
object[]