Sign in
latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

assistantActions

Create an assistant action

post/assistantActions

Request body

_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.

descriptionstring required

Free-form description of the action taken.

status'success' | 'failure' | 'pending' required

Outcome of the underlying API call this action made.

functionNamestring required

Name of the tool/function called, for example cancelAppointment or listAvailabilities.

{"stackTrail":"components:schemas:AssistantActionRequestCreate:properties:parameters","oasType":"schema","type":"unknown","description":"The parameters passed to the underlying API call."}
{"stackTrail":"components:schemas:AssistantActionRequestCreate:properties:response","oasType":"schema","type":"unknown","description":"The raw response returned by the underlying API call."}
assistantInstancestring required

ID of the AssistantInstance (conversation) this action was taken during.

Response

Successful creation

_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.

descriptionstring

Free-form description of the action taken.

status'success' | 'failure' | 'pending'

Outcome of the underlying API call this action made.

functionNamestring

Name of the tool/function called, for example cancelAppointment or listAvailabilities.

{"stackTrail":"components:schemas:AssistantActionResponse:properties:parameters","oasType":"schema","type":"unknown","description":"The parameters passed to the underlying API call."}
{"stackTrail":"components:schemas:AssistantActionResponse:properties:response","oasType":"schema","type":"unknown","description":"The raw response returned by the underlying API call."}
assistantInstancestring

ID of the AssistantInstance (conversation) this action was taken during.