Skip to main content
POST
/
agents
/
{agentId}
/
knowledge
/
preview
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "chunks": [
      {
        "id": "<string>",
        "answer": "<string>",
        "language": "<string>",
        "similarity": 123,
        "question": "<string>",
        "sourceUrl": "<string>"
      }
    ],
    "topScore": 123
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

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

Body

application/json
query
string
required
sourceIds
string[]

Response

Preview chunks + top score.

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