Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"chunks": [
{
"id": "chk_11",
"question": "Do you offer weekend service?",
"answer": "Yes — we offer weekend appointments for heating and cooling, including heat pumps.",
"language": "en",
"sourceUrl": "https://peakcomforthvac.com/faq",
"similarity": 0.91
}
],
"topScore": 0.91
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Knowledge
Preview knowledge search
Runs a search query against the agent’s indexed knowledge and returns the best-matching passages with similarity scores. Use it to test coverage and see what the agent would retrieve for a question. You can optionally limit the search to specific sources.
POST
/
agents
/
{agentId}
/
knowledge
/
preview
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"chunks": [
{
"id": "chk_11",
"question": "Do you offer weekend service?",
"answer": "Yes — we offer weekend appointments for heating and cooling, including heat pumps.",
"language": "en",
"sourceUrl": "https://peakcomforthvac.com/faq",
"similarity": 0.91
}
],
"topScore": 0.91
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
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.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
knowledge:read
Read knowledge sources & preview.
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
Body
application/json