Skip to main content
GET
Get an Omni call record

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Path Parameters

call_id
string
required

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

Pattern: ^ocl_[A-Za-z0-9]{20}$
Example:

"ocl_7Hk2Qm9Zs4Wp8Lc3Nv6R"

Response

Omni call detail

object
string
Example:

"omni.call"

call_id
string

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

Pattern: ^ocl_[A-Za-z0-9]{20}$
Example:

"ocl_7Hk2Qm9Zs4Wp8Lc3Nv6R"

session_label
string | null

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

external_id
string | null

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
enum<string>
Available options:
completed,
failed
duration_s
number | null
language
enum<string>

Language the session was served in. Records from before multilingual rollout render the default, en.

Available options:
en,
fr,
es,
de,
hi
voice_tier
enum<string>

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.

Available options:
standard,
natural
has_recording
boolean
has_summary
boolean
started_at
integer | null

Unix ms when the session started.

created_at
integer

Unix ms when the record was written.

transcript
object | null

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

transcript_url
string

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

summary
object

Structured post-call summary, when generated.

recording_result
object

Provider-neutral recording outcome. Internal source and storage details are never returned.

error
enum<string>

Normalized failure reason, present when status is failed.

Available options:
call_failed