Skip to main content

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

Download Microsoft Edge More info about Internet Explorer and Microsoft Edge
microsoft-foundry.rest.security.o-auth2-auth

Agent Conversations

Get a voice agent conversation's merged recording metadata

GET /agents/{agent_name}/endpoint/protocols/voice/conversations/{conversation_id}/audio

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.

Header parameters

Foundry-Features enum required

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

VoiceAgents=V1Preview

Path parameters

agent_name string required

The name of the agent.

conversation_id string required

The id of the conversation whose merged recording metadata is retrieved.

Query parameters

api-version string required

The API version to use for this operation.

Responses

The request has succeeded.

Body

Content-Type: application/json
conversation_id string required

The id of the conversation this recording belongs to.

format string | enum required

An audio container format. Additional values may be added over time.

Any of the following:
string
enum
wav
sample_rate integer required

The sample rate of the recording in Hz, e.g. 24000.

channels integer required

The number of audio channels. The merged recording is stereo (2).

channel_layout VoiceRecordingChannelLayout required

The role assigned to each channel of a merged stereo voice recording.

left enum required

The role carried on the left channel. Always user.

user
right enum required

The role carried on the right channel. Always agent.

agent
duration_ms integer required

A duration encoded as an integer number of milliseconds.

blob_uri string

For bring-your-own-storage (BYOS) recordings only: the URI of the recording in the customer's own storage, without a SAS token. The customer downloads it using their own storage credentials. Absent for Foundry-managed storage, where the bytes are streamed via the /audio/content route instead.

Client error

Body

Content-Type: application/json
error OpenAI.Error required
code string | null required
message string required
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Any of the following:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string required

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object

Server error

Body

Content-Type: application/json
error OpenAI.Error required
code string | null required
message string required
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Any of the following:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string required

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object

Request

GET /agents/{agent_name}/endpoint/protocols/voice/conversations/{conversation_id}/audio HTTP/1.1

Response

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
en-us
Your Privacy Choices
  • AI Disclaimer
  • Previous Versions
  • Blog
  • Contribute
  • Privacy
  • Consumer Health Privacy
  • Terms of Use
  • Trademarks
  • © Microsoft 2026