Retrieve an Audio Stream

GET

api

Account

{auth_id}

Call

{call_uuid}

Stream

{stream_id}

Retrieve a stream

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/

This endpoint returns a full Stream object for a specific stream attached to a given call. Use it to check the current status, configuration, and timing of an ongoing or completed stream.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your account ID.
`call_uuid`	string	Yes	UUID of the call.
`stream_id`	string	Yes	Unique ID of the stream.

Response

Success Response (200 OK)

Response - 200 OK

{
  "stream_id": "728e273b-9c2c-4902-8509-2f88224cd3d5",
  "call_uuid": "c6ebf396-59c2-4f2a-8771-fbb5d981e301",
  "service_url": "wss://your-server.com/ws",
  "status_callback_url": "https://your-server.com/stream-status",
  "bidirectional": true,
  "audio_track": "both",
  "content_type": "audio/x-l16;rate=16000",
  "status": "in-progress",
  "start_time": "2026-04-24T09:25:00Z",
  "end_time": null
}

Error Response (404 Not Found)

Response - 404 Not Found

{
    "api_id": "correlation-id-uuid",
    "error": "Stream not found"
}

Example

cURL

curl -X GET 'https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/' \
  -H 'X-Auth-ID: {auth_id}' \
  -H 'X-Auth-Token: {auth_token}'

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

call_uuid

string

required

stream_id

string

required

Response

200

Stream details

Retrieve a stream

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Path parameters

​Response

​Success Response (200 OK)

​Error Response (404 Not Found)

​Example

Authorizations

Path Parameters

Response

Path parameters

Response

Success Response (200 OK)

Error Response (404 Not Found)

Example