Omni

Get an Omni call record

Full record for one Omni session, addressed by the stable opaque PyAI call_id returned by the list: transcript (inline or via transcript_url), recording availability, and summary when generated. Recording bytes are retrieved from the dedicated recording sub-resource. Requires omni:read.

get/v1/omni/calls/{call_id}

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/omni/calls/{call_id}
  • 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

Response

Omni call detail

objectstring
call_idstring

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

session_labelstring nullable

The opaque tag passed on the connect URL, if any.

external_idstring nullable

Customer-supplied correlation id echoed from the call's meta (the engine carries configure.meta into the ingest). Use it to join a call to your own record; null when none was set.

status'completed' | 'failed'
duration_snumber nullable
language'en' | 'fr' | 'es' | 'de' | 'hi' | 'zh' | 'it' | 'pt' | 'ja' | 'ko'

Language the session was served in. Call history also retains languages used in private qualification; record recognition does not enable those languages for public agent configuration. Older records render the default, en.

voice_tier'standard' | 'natural'

Voice tier served for the session. English en1 sessions report natural while that tier is active; Standard voices report standard. Both are included in the Omni base rate with no voice-tier add-on. Inspect the configured acknowledgement and call record rather than inferring the served tier from the requested alias.

has_recordingboolean
has_summaryboolean
started_atinteger nullable

Unix ms when the session started.

created_atinteger

Unix ms when the record was written.

transcriptobject nullable

Inline transcript document; omitted in favor of transcript_url when offloaded.

transcript_urlstring

Signed URL to the transcript when it was offloaded instead of inlined.

summaryobject

Structured post-call summary, when generated.

error'call_failed'

Normalized failure reason, present when status is failed.

Example response

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

Changes

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