Skip to content

Create Agent Voice Draft

POST
/agent/sessions/voice/draft

Create an EMPTY session to speak into.

It creates only the conversation - never a synthetic opening turn from the agent. That is deliberate in the app and worth preserving: a fabricated first message would appear in the transcript as something the agent said when it had not yet heard anything.

session_id is caller-generated, so a client can open its socket and create the row without a round trip between the two. Sending the same id twice does not create a second session.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of VoiceDraftRequest.

object
session_id
required

The id the new session will have - CALLER-GENERATED, not server-assigned. That is what lets a client open the socket and create the row without a round trip between them. Reusing an id does not create a second session.

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