Voice
4 operations. {prefix} is the route prefix passed to
MapAgentPrism; the template uses /agentprism.
GET {prefix}/api/voice/health
Section titled “GET {prefix}/api/voice/health”Operation ID: AgentPrismVoiceHealth
Checks the voice provider’s availability.
The check does not incur cost: no speech is generated, only the available voices are read.
Authorization: bearer authentication; Reader role policy when that policy is registered; PlatformRead API-key scope.
| Response | Body | Headers |
|---|---|---|
| 200 OK | application/json → VoiceHealth |
— |
GET {prefix}/api/voice/sessions
Section titled “GET {prefix}/api/voice/sessions”Operation ID: AgentPrismVoiceSessions
Lists the summary record of real-time speech connections.
The record does NOT contain audio: it only carries duration, turn count, and metering. If the speech layer is not enabled, the list is empty.
Authorization: bearer authentication; Reader role policy when that policy is registered; RunsRead API-key scope.
| Parameter | In | Required | Type | Description and rules |
|---|---|---|---|---|
agentName |
query | no | string |
— |
sessionId |
query | no | string |
— |
skip |
query | no | integer (int32) |
pattern `^-?(?:0\ |
take |
query | no | integer (int32) |
pattern `^-?(?:0\ |
| Response | Body | Headers |
|---|---|---|
| 200 OK | application/json → array of VoiceSessionRecord |
— |
POST {prefix}/api/voice/speak
Section titled “POST {prefix}/api/voice/speak”Operation ID: AgentPrismVoiceSpeak
Synthesizes speech from text and saves it as an attachment.
This is an operator action and is NOT tied to a run; the metering is not written to tool_invocations, it is returned in the response. If persistent metering is required, use the agent’s speak tool.
Authorization: bearer authentication; Operator role policy when that policy is registered; RunsWrite API-key scope.
Request body (required):
application/json→SpeakRequest
| Response | Body | Headers |
|---|---|---|
| 200 OK | application/json → SpeakResponse |
— |
GET {prefix}/api/voice/voices
Section titled “GET {prefix}/api/voice/voices”Operation ID: AgentPrismVoiceList
Lists the available voices.
The list comes from the configured speech provider, not from AgentPrism; the identifiers it returns are the values the speak endpoint and the agent’s ‘speak’ tool accept. When the speech layer was never enabled with UseVoice, the response is 501 rather than 404, so a missing configuration is not mistaken for a wrong address.
Authorization: bearer authentication; Reader role policy when that policy is registered; AgentsRead API-key scope.
| Response | Body | Headers |
|---|---|---|
| 200 OK | application/json → array of VoiceDescriptor |
— |