Skip to main content
GET
Get agent

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.

Path Parameters

sid
string
required

The agent (ub_ag_…): one of search_agents, the default among them (is_default).

Required string length: 18
Pattern: ^ub_ag_

Query Parameters

include[]
enum<string>[]

availability: whether our runtime is taking the team's agent work, since when it is not, and how many conversations wait. readiness: the five steps to go live with their states and counts. Anything else is a 422.

Available options:
availability,
readiness

Response

get success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
get
item
object
required
included
object
required
includes
string[]
required
meta
object
required