Skip to content
OnCoreDocs
Calls

GEThttps://core-api.heysadie.ai/calls/{id}/monitor-sessions

id success data sessions monitorIdentity actorLabel createdAt expiresAt takeoverStartedAt takeoverEndedAt closedAt total metadata timestamp version path error code message details field

List calls monitor sessions

Try it in the API Explorer

Example request

Terminal
curl "https://core-api.heysadie.ai/calls/CALL_ID/monitor-sessions" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme. See Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key: it selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

Responses

200
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 2 child properties
sessionsobject[]required

Monitor sessions opened against this call.

Show 8 item properties
idstringrequired

`monitor_sessions.id`.

monitorIdentitystringrequired
actorLabelstring | nullrequired

Exactly as it was supplied, and not evidence of anything: a label the caller attached, recorded verbatim and never believed, because an API key carries a tenant and no person. Say that wherever it is displayed.

createdAtstringrequired
expiresAtstringrequired

When the token stopped being accepted at connect. Not when the session ended: LiveKit checks a token only at connect.

takeoverStartedAtstring | nullrequired

When this monitor last took the call over, or null if it never did. A session that took over, handed back and took over again carries the most recent intervention; per-intervention audit is a v2 item.

takeoverEndedAtstring | nullrequired
closedAtstring | nullrequired
totalnumberrequired

Number of sessions returned

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

400The request is invalid. `details` lists each field that failed
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

A parameter or body field broke a rule

Allowed values:"VALIDATION_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobject[]optional

One entry per field that failed

Show 2 item properties
fieldstringrequired

The offending field

messagestringrequired

The rule it broke

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

401Missing or invalid credentials
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

No valid credentials

Allowed values:"UNAUTHORIZED"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

403The credentials are valid but may not use this route
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

The credentials may not use this route

Allowed values:"FORBIDDEN"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

404
errorenumrequired
Allowed values:"not_found"
500An unexpected server error
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An unexpected server failure

Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested