Omni

Download an Omni call recording

Fetch the call's audio recording, when one exists (recording is off by default). Requires omni:read.

By default the endpoint streams audio bytes from the tenant-scoped PyAI resource (Content-Type reflects the stored format, e.g. audio/wav). Pass ?response=url to receive the canonical authenticated PyAI resource URL as JSON. Storage locations, raw recording URLs, and internal source identifiers are never returned.

404 if there is no recording for the call.

get/v1/omni/calls/{call_id}/recording

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/omni/calls/{call_id}/recording
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

call_idstring required

Stable opaque PyAI-owned call identifier. Use it unchanged across every Omni call sub-resource.

Example:ocl_7Hk2Qm9Zs4Wp8Lc3Nv6R

Query parameters

response'url'

Set to url to return the canonical authenticated PyAI recording resource as JSON.

Response

The canonical PyAI resource as JSON (?response=url), or the audio bytes streamed inline.

objectstring
call_idstring

Stable opaque PyAI-owned call identifier. Use it unchanged across every Omni call sub-resource.

urlstring uri

Canonical authenticated PyAI endpoint for the recording audio.

Example response

{
  "object": "omni.call.recording",
  "call_id": "ocl_7Hk2Qm9Zs4Wp8Lc3Nv6R"
}

Changes

No recorded changes to this operation across all 1 revision of this API.