Skip to content

Quote Agent Session Voice

POST
/agent/sessions/{session_id}/voice/quote

What a voice session WOULD cost. Charges nothing.

A POST only because the ceilings are a body. It returns a credit figure and a rate_version, and that version is the point: hand it straight to POST /agent/sessions/{session_id}/voice, which refuses a stale one rather than starting at today’s price against yesterday’s quote.

Tiered as a READ for that reason. It is the only way to learn the price before committing to it, so a read-only key must be able to call it.

Authorizations

Parameters

Path Parameters

session_id
required

Session id (UUID).

string

Session id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of VoiceQuoteRequest, including its extra="forbid".

object
max_input_seconds

Ceiling on spoken input to price for.

integer
default: 600 >= 1 <= 1200
max_output_characters

Ceiling on synthesised output to price for.

integer
default: 5000 <= 60000
voice_id
required

Which voice to price.

string format: uuid

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