Skip to main content
GET
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.

FlowClient Credentials
Token URL
/api/v1/api-keys
Scopes1
analytics:read
Read the Observe history list, per-agent analytics (the answer-rate summary), the raw knowledge-gap list, and the metric catalog + per-metric queries + metric drill-downs.

Path Parameters

agentId
string
required

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

Query Parameters

limit
integer
default:50

Maximum number of gaps to return (1–200). Defaults to 50.

Required range: 1 <= x <= 200
status
enum<string>

Filter the RANKED list by gap status. Ignored for the raw fallback list below the volume floor.

Available options:
open,
in_progress,
covered,
dismissed

Response

The knowledge-gap list. Above the per-agent volume floor ranked is true and rows carry gapId/rankScore/classification/status (the clustered list); below it ranked is false and rows are the deduped fallback.

success
boolean
required
data
object
required

The GET /agents/{agentId}/knowledge-gaps response. dataState is collecting below a small volume floor (the raw list is useful from call #1 but signals "still gathering") and ready once a handful of gaps land. M4 adds rankScore, cluster representativeQuery, status, and the TRUE_GAP/RETRIEVAL_MISS class.

message
string
errors
object[]