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 item's generated audio metadata

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

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.

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 that contains the item.

item_id string required

The id of the conversation item whose generated audio 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 the item belongs to.

item_id string required

The id of the item this audio belongs to.

role string | enum

A voice-audio participant role. Additional values may be added over time.

Any of the following:
string
enum
useragent
format string | enum

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

Any of the following:
string
enum
wav
codec string | enum

An audio codec. Additional values may be added over time.

Any of the following:
string
enum
pcm16pcmupcma
sample_rate integer

The sample rate in Hz.

channels integer

The number of audio channels.

start_offset_ms integer

A duration encoded as an integer number of milliseconds.

duration_ms integer

A duration encoded as an integer number of milliseconds.

blob_uri string

For bring-your-own-storage (BYOS) recordings only: the URI of the generated audio 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 item's /audio/generated/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}/items/{item_id}/audio/generated 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