Agent Conversations
Get a voice agent conversation response
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.
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
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.
enum
voice_locale
string
The BCP-47 locale of the voice used for the response's audio output.
format
audio/pcm | audio/pcmu | audio/pcma
audio/pcm
OpenAI.RealtimeAudioFormatsAudioPcm
type
enum
required
rate
enum
audio/pcmu
OpenAI.RealtimeAudioFormatsAudioPcmu
type
enum
required
audio/pcma
OpenAI.RealtimeAudioFormatsAudioPcma
type
enum
required
metadata
object
A set of key-value pairs attached to the response.
temperature
number
The sampling temperature used for the response.
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