Skip to content

Get Agent Voice Capability

GET
/agent/sessions/voice/capability

Can this workspace use voice at all, and what does it cost.

The org-wide answer, with indicative pricing - ask this before building a voice affordance into a UI. The per-session twin (GET /agent/sessions/{session_id}/voice) answers the same question for one conversation and additionally checks the caller owns it.

available: false comes with a reason, so a client can say WHY rather than hiding the control.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a hydration or voice answer.

Open because session hydration returns the agent’s STEPS as well as its messages, and a step’s detail is whatever the tool that produced it reported. That set grows with every tool the platform gains, and a pinned mirror would drop the detail of exactly the newest ones - which on a transcript surface reads as the agent having done less than it did.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string