BetaVoiceAgentsConversationsOperations interface
Operations for managing voice agent conversations.
Properties
| delete | Deletes a conversation and all of its stored data — responses, items, and any audio (cascade). This is the customer's explicit data-deletion control for voice conversations. |
| download |
Streams the whole-call merged stereo recording as a WAV ( |
| download |
Streams a single conversation item's audio as a WAV ( |
| download |
Streams a conversation item's generated audio as a WAV ( |
| get | Retrieves a single conversation recorded for the specified voice agent endpoint by its id.
Returns |
| get |
Returns metadata for the whole-call merged stereo recording (user audio on the left channel, agent audio
on the right). The common metadata (format, sample rate, channels, channel layout, duration) is returned
for both Foundry-managed and bring-your-own-storage (BYOS) recordings; for BYOS the response additionally
includes |
| get |
Returns metadata for a single conversation item's audio segment, including the common playback facts
(role, format/codec, sample rate, channels, offset, duration) for both Foundry-managed and
bring-your-own-storage (BYOS) recordings; for BYOS the response additionally includes |
| get |
Returns metadata for a conversation item's generated audio. This subordinate artifact is separate from the
canonical heard-audio segment and exists only when playback was interrupted and the service rendered more audio
than the listener heard, including when the response ends as cancelled. Returns |
| get |
Retrieves a single item from the specified conversation by its id, including its transcript. An
|
| get |
Retrieves a single response from the specified conversation by its id, including its |
| list | Returns the conversations persisted for the specified voice agent endpoint.
Conversations are present when the session's effective |
| list |
Returns a paged collection of items — the complete ordered conversation history, including user input,
assistant output, and client-created tool outputs (transcripts + tool events). Returns |
| list |
Returns a paged collection of the output items produced by a specific response (the response's output
projection). For the complete ordered conversation history — including user input and client-created
tool outputs — use the conversation items route instead. Returns |
| list |
Returns a paged collection of the responses (model inference turns) recorded for the specified
conversation. The per-response |
Property Details
delete
Deletes a conversation and all of its stored data — responses, items, and any audio (cascade). This is the customer's explicit data-deletion control for voice conversations.
delete: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>Property Value
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>
downloadAudio
Streams the whole-call merged stereo recording as a WAV (audio/wav) byte stream through the service
(no SAS URL). This route serves Foundry-managed storage only. For bring-your-own-storage (BYOS)
recordings the bytes are not proxied — the caller must download directly from customer storage using the
blob_uri returned by the metadata route — so this route returns 409 Conflict for BYOS recordings.
While the conversation is in_progress, this route returns retriable 409 Conflict with
error.code = recording_not_ready and a Retry-After header when retry guidance is available. When the
conversation is failed, it returns terminal 409 Conflict with error.code = recording_unavailable.
For a completed conversation, content is available subject to the existing BYOS behavior. A conversation
without persisted audio (store = false) returns 404.
downloadAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>Property Value
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>
downloadAudioItem
Streams a single conversation item's audio as a WAV (audio/wav) byte stream through the service (no SAS
URL). This route serves Foundry-managed storage only. For bring-your-own-storage (BYOS) recordings the
bytes are not proxied — the caller must download directly from customer storage using the blob_uri
returned by the item's /audio metadata route — so this route returns 409 Conflict for BYOS recordings.
Returns 404 when the conversation, item, or its audio was not persisted (store = false).
downloadAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>Property Value
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>
downloadGeneratedAudioItem
Streams a conversation item's generated audio as a WAV (audio/wav) byte stream through the service. This
subordinate artifact exists only when playback was interrupted and the service rendered more audio than the
listener heard, including when the response ends as cancelled. This route serves Foundry-managed storage only.
For bring-your-own-storage (BYOS) recordings the bytes are not proxied, so this route returns 409 Conflict.
Returns 404 when the conversation or item was not persisted, or when no generated audio exists beyond the
heard segment.
downloadGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>Property Value
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>
get
Retrieves a single conversation recorded for the specified voice agent endpoint by its id.
Returns 404 when the conversation was not persisted (store = false) or does not exist.
get: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>Property Value
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>
getAudio
Returns metadata for the whole-call merged stereo recording (user audio on the left channel, agent audio
on the right). The common metadata (format, sample rate, channels, channel layout, duration) is returned
for both Foundry-managed and bring-your-own-storage (BYOS) recordings; for BYOS the response additionally
includes blob_uri, the URI of the recording in the customer's own storage (no SAS) that the customer downloads
with their own credentials. The recording is built once from the per-turn segments after persistence
finalization succeeds. While the conversation is in_progress, this route returns retriable 409 Conflict
with error.code = recording_not_ready and a Retry-After header when retry guidance is available. When the
conversation is failed, it returns terminal 409 Conflict with error.code = recording_unavailable.
For a completed conversation, metadata is available subject to the existing BYOS behavior. Requires the
conversation to have persisted audio (store = true); otherwise returns 404.
getAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>Property Value
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>
getAudioItem
Returns metadata for a single conversation item's audio segment, including the common playback facts
(role, format/codec, sample rate, channels, offset, duration) for both Foundry-managed and
bring-your-own-storage (BYOS) recordings; for BYOS the response additionally includes blob_uri, the URI
of the recording in the customer's own storage (no SAS) that the customer downloads with their own credentials.
Requires the conversation to have persisted audio (store = true); returns 404 when the conversation,
item, or its audio was not persisted.
getAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>Property Value
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>
getGeneratedAudioItem
Returns metadata for a conversation item's generated audio. This subordinate artifact is separate from the
canonical heard-audio segment and exists only when playback was interrupted and the service rendered more audio
than the listener heard, including when the response ends as cancelled. Returns 404 when the conversation or
item was not persisted, or when no generated audio exists beyond the heard segment.
getGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>Property Value
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>
getItem
Retrieves a single item from the specified conversation by its id, including its transcript. An
input_audio/output_audio content part indicates that audio is available for the item; the canonical per-item
audio metadata is the /items/{item_id}/audio resource, and the bytes are streamed by
/items/{item_id}/audio/content. Returns 404 when the conversation or item was not persisted
(store = false).
getItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>Property Value
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>
getResponse
Retrieves a single response from the specified conversation by its id, including its output items,
usage, and status. Returns 404 when the conversation or response was not persisted (store = false).
getResponse: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>Property Value
(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>
list
Returns the conversations persisted for the specified voice agent endpoint.
Conversations are present when the session's effective store setting is true, whether inherited from the
agent definition or enabled by the WebSocket session override.
list: (agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>Property Value
(agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>
listItems
Returns a paged collection of items — the complete ordered conversation history, including user input,
assistant output, and client-created tool outputs (transcripts + tool events). Returns 404 when the
conversation was not persisted (store = false).
listItems: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>Property Value
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
listResponseItems
Returns a paged collection of the output items produced by a specific response (the response's output
projection). For the complete ordered conversation history — including user input and client-created
tool outputs — use the conversation items route instead. Returns 404 when the conversation or
response was not persisted (store = false).
listResponseItems: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>Property Value
(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
listResponses
Returns a paged collection of the responses (model inference turns) recorded for the specified
conversation. The per-response output projection may be omitted here; use the response-items route
for the canonical paged output. Returns 404 when the conversation was not persisted (store = false).
listResponses: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>Property Value
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>