Get Conversation Audio

Stream Conversation Audio

curl --request GET \
  --url https://api.inya.ai/platform/v1/conversations/{conversationId}/audio \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.inya.ai/platform/v1/conversations/{conversationId}/audio"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.inya.ai/platform/v1/conversations/{conversationId}/audio', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

"<string>"

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

GET

conversations

{conversationId}

audio

Stream Conversation Audio

curl --request GET \
  --url https://api.inya.ai/platform/v1/conversations/{conversationId}/audio \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.inya.ai/platform/v1/conversations/{conversationId}/audio"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.inya.ai/platform/v1/conversations/{conversationId}/audio', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

"<string>"

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

Overview

Retrieve the audio recording of a completed conversation as a binary stream. The response body contains the raw audio data (audio/mpeg) which can be streamed directly to an audio player, downloaded as an MP3, or processed programmatically for transcription or archiving.

Required Permission

conversations

Path Parameters

Name	Type	Required	Description
`conversationId`	string	Yes	Unique identifier of the conversation.

Response

Success (200)

Returns the audio recording as a binary stream with Content-Type: audio/mpeg. The response body is the raw MP3 data.

Error Responses

403 Forbidden - Insufficient permissions

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "User does not have access to this conversation"
}

404 Not Found - Audio recording not available

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Audio URL not found"
}

Example Usage

Download as MP3 (cURL)

curl -H "x-api-key: <your_api_key>" \
  "https://api.inya.ai/platform/v1/conversations/conv_abc123/audio" \
  --output conversation.mp3

Stream and Play (JavaScript)

const response = await fetch(
  'https://api.inya.ai/platform/v1/conversations/conv_abc123/audio',
  { headers: { 'x-api-key': '<your_api_key>' } }
);
const blob = await response.blob();
const audioUrl = URL.createObjectURL(blob);
const audio = new Audio(audioUrl);
audio.play();

Stream and Save (Python)

import requests

response = requests.get(
  'https://api.inya.ai/platform/v1/conversations/conv_abc123/audio',
  headers={'x-api-key': '<your_api_key>'},
  stream=True
)
with open('conversation.mp3', 'wb') as f:
    for chunk in response.iter_content(chunk_size=8192):
        f.write(chunk)

Use Cases

Downloading conversation recordings for quality assurance and coaching
Archiving recordings for compliance and audit requirements
Feeding recordings into transcription or sentiment analysis pipelines
Sharing specific calls with team members for review

Audio recordings may contain sensitive personal information. Ensure proper access controls are in place and comply with applicable data privacy regulations (e.g. GDPR, DPDP Act) before storing or sharing recordings.

Audio availability depends on your recording settings. If recording is disabled for an agent, or the conversation was too short, this endpoint will return a 404 error.

Save the requestId from every response. You will need it if you contact Inya support to trace a specific request.

Authorizations

x-api-key

string

header

required

API key with 'conversations' permission

Path Parameters

conversationId

string

required

Unique identifier of the conversation.

Response

Audio recording returned as a binary stream

The response is of type file.

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Get Conversation Audio

Overview

Required Permission

Path Parameters

Response

Success (200)

Error Responses

Example Usage

Download as MP3 (cURL)

Stream and Play (JavaScript)

Stream and Save (Python)

Use Cases

Authorizations

Path Parameters

Response

​Overview

​Required Permission

​Path Parameters

​Response

​Success (200)

​Error Responses

​Example Usage

​Download as MP3 (cURL)

​Stream and Play (JavaScript)

​Stream and Save (Python)

​Use Cases

Authorizations

Path Parameters

Response

Overview

Required Permission

Path Parameters

Response

Success (200)

Error Responses

Example Usage

Download as MP3 (cURL)

Stream and Play (JavaScript)

Stream and Save (Python)

Use Cases