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 response

GET /agents/{agent_name}/endpoint/protocols/voice/conversations/{conversation_id}/responses/{response_id}

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).

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 response.

response_id string required

The id of the response to retrieve.

Query parameters

api-version string required

The API version to use for this operation.

Responses

The request has succeeded.

Body

Content-Type: application/json
id string required

The unique id of the response.

output OpenAI.RealtimeConversationItem[]

The output items produced by the response. May be omitted in list results; retrieve the full response (GET .../responses/{response_id}) or use the paged response-items route (GET .../responses/{response_id}/items) for its output items. Each item's response_id also links it back to this response in the conversation-level items list.

conversation_id string required

The id of the conversation this response belongs to.

audio VoiceResponseAudio

Audio configuration for a response. Follows the OpenAI Realtime GA audio object shape.

output VoiceResponseAudioOutput

The flat response audio-output projection, with optional voice, voice_type, voice_locale, and format fields.

voice string

The voice name used for the response's audio output.

voice_type string | enum

The voice implementation. Additional values may be added over time.

Any of the following:
string
enum
openaiazure-standardazure-customazure-personalavatar-voice-syncazure-realtime-native
voice_locale string

The BCP-47 locale of the voice used for the response's audio output.

format audio/pcm | audio/pcmu | audio/pcma
One of the following:
audio/pcm OpenAI.RealtimeAudioFormatsAudioPcm
type enum required
audio/pcm
rate enum
24000
audio/pcmu OpenAI.RealtimeAudioFormatsAudioPcmu
type enum required
audio/pcmu
audio/pcma OpenAI.RealtimeAudioFormatsAudioPcma
type enum required
audio/pcma
metadata object

A set of key-value pairs attached to the response.

[key: string] string
temperature number

The sampling temperature used for the response.

created_at integer
completed_at integer

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}/responses/{response_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