Agents

Start Agent Session Voice

Start speaking with the agent. THIS SPENDS CREDITS AS IT RUNS.

A live metered session: it begins charging when it connects and keeps charging until it is ended or hits max_credits. Quote it first.

max_credits is a HARD CEILING and is required - there is no default, because choosing one would mean this contract picking a spending limit on the customer's behalf. rate_version must be the one the quote returned.

End it with DELETE /agent/sessions/{session_id}/voice/{voice_id}. A session left open keeps costing money.

post/agent/sessions/{session_id}/voice

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/agent/sessions/{session_id}/voice
  • Auth: HTTP bearer

Path parameters

session_idstring required

Session id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

voice_idstring uuid required

Which voice to speak with.

rate_versionstring required

The rate version the quote was issued against, from POST /agent/sessions/{session_id}/voice/quote. The server refuses a stale one rather than charging today's price for yesterday's quote.

max_creditsinteger required

HARD CEILING on what this session may spend. Required, with no default: an uncapped voice session is an open-ended charge, and a contract that defaults it would be choosing a spending limit on the customer's behalf.

Response

Successful Response

dataAgentSessionStatePayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.