LUlumahealth
assistantInstances

Get assistant instance by id

get/assistantInstances/{assistantInstanceId}

Request

Path parameters

assistantInstanceIdstring required

AssistantInstance's unique identifier in Luma's database.

Response

AssistantInstance

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

release'current' | 'next' | 'preProd'

Which release track of the assistant handled this conversation.

patientstring

ID of the patient in this conversation.

verifiedboolean

Whether the patient's identity has been confirmed.

onBehalfOfstring

ID of the patient being discussed, when different from patient (for example, a guardian calling about a dependent).

status'idle' | 'in-progress' | 'failure' | 'success'

Lifecycle status of the conversation.

statusUpdatedAtstring date-time

When status was last updated.

statusReason'success-by-assistant' | 'success-by-transfer' | 'success-by-patient' | 'success-by-staff' | 'success-by-assistant-timeout' | 'failure-by-assistant' | 'failure-by-patient' | 'failure-by-staff' | 'incomplete-success-criteria' | 'timed-out' | 'no-new-messages' | 'maximum-retries'

Why the conversation reached its terminal status.

assistantstring

ID of the Assistant configuration driving this conversation.

startedAtstring date-time
finishedAtstring date-time
durationnumber

Duration of the conversation, in seconds.

Changes

No recorded changes to this operation across all 6 revisions of this API.