Skip to main content
POST
Ask the Knowledge answers

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of ask_agent_answers.

q
string
required

The text to read for, as a lead would write it: a question, a request ("send me the price list").

Required string length: 1 - 2000
agent_sid
string

Whose Knowledge to read (ub_ag_…, block 10, 2026-10-30); left out, the team's default agent's.

Required string length: 18
Pattern: ^ub_ag_
k
integer

How many answers to return, nearest first; default 5, what a turn reads at most.

Required range: 1 <= x <= 20

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required