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 Live Conversations

Get a Live voice agent conversation item

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

Gets a stored item by ID. Returns 404 if the item or conversation is absent.

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 Live voice agent.

conversation_id string required

The Foundry conversation ID returned in session.started.conversation_id.

item_id string required

The id returned on the persisted item.

Query parameters

api-version string required

The API version to use for this operation.

Responses

The request has succeeded.

Body

Content-Type: application/json
One of the following:
input VoiceAgentLiveInputConversationItem

A stored user speech segment.

type enum required
input
transcription string

Captured user transcription, when available.

audio VoiceAudioItem

Metadata for a single conversation item's audio segment. For bring-your-own-storage (BYOS), the response includes blob_uri, a direct customer-storage URI without a SAS token, that the customer accesses with their own credentials. For Foundry-managed storage, blob_uri is absent and the bytes are streamed through the item's /audio/content route.

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 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 item's /audio/content route instead.

output VoiceAgentLiveOutputConversationItem

A stored assistant speech segment.

type enum required
output
transcription string

Captured assistant transcription, not backend output or commentary guidance.

audio VoiceAudioItem

Metadata for a single conversation item's audio segment. For bring-your-own-storage (BYOS), the response includes blob_uri, a direct customer-storage URI without a SAS token, that the customer accesses with their own credentials. For Foundry-managed storage, blob_uri is absent and the bytes are streamed through the item's /audio/content route.

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 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 item's /audio/content route instead.

delegation client | responses | foundry_managed_agent

A stored delegation using native fields with Foundry-specific targets. Its id is the native delegation ID.

One of the following:
client VoiceAgentLiveClientDelegationConversationItem

Results supplied by the application for client delegation.

target enum required
client
commentary string

Guidance for Live to communicate to the user, when accepted.

thinking string

Accepted background context, not private reasoning or a request to speak.

responses VoiceAgentLiveResponsesDelegationConversationItem

Stored Responses delegation output, separate from Live speech.

target enum required
responses
output string

Final backend text, omitted when unavailable; excludes raw tool output.

foundry_managed_agent VoiceAgentLiveFoundryManagedAgentDelegationItem

Stored prompt-agent delegation state and accepted results.

target enum required
foundry_managed_agent
agent_name string required

Target agent name in the same project.

agent_version string required

Target version pinned at connection start.

offset_ms integer required

A duration encoded as an integer number of milliseconds.

backend_conversation_id string

Backend conversation ID, distinct from the voice conversation and Live session IDs.

output VoiceAgentLiveDelegationResultItem[] required

Accepted guidance in order; empty until a result is accepted. Entries have no individual IDs, are noncumulative, and are independent of backend output_index. Partial results survive failure or cancellation.

delegation_context string

Task context sent to the target agent, not the full request body.

status string | enum required

Persisted delegation outcome, not speech or playback status.

Any of the following:
string
enum
in_progresscompletedfailedincompletecancelled

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[]

Additional errors that contributed to this failure.

additionalInfo object

Additional structured information about the failure.

debugInfo object

Diagnostic information supplied by the service for troubleshooting.

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[]

Additional errors that contributed to this failure.

additionalInfo object

Additional structured information about the failure.

debugInfo object

Diagnostic information supplied by the service for troubleshooting.

Request

GET /agents/{agent_name}/endpoint/protocols/voice/live/conversations/{conversation_id}/items/{item_id} 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