Engine

Covers Engine 2.0.0

argus/respond-to-prompt

Responds to prompt.

  • Category: Events

Request payload

FieldTypeRequirementDescription
event_idstringOptionalStable prompt event ID. When omitted, a title lookup is used.
prompt_titlestringOptionalIn-memory prompt title. title is accepted as an alias.
titlestringOptionalAlias used for prompt/event lookup.
message_titlestringOptionalCompatibility event-title lookup used when resolving event_id.
prompt_typestringOptionalResponse conversion type; defaults to string.
prompt_responsestringOptionalResponse text. response is accepted as an alias.
responsestringOptionalAlias for prompt_response.

Response payload

FieldTypeDescription
event_idstringResolved event ID, or an empty string for an in-memory prompt without an ARGUS event.
prompt_foundbooleanWhether a live in-memory prompt received the response.

Errors

  • Neither a live prompt nor an event can be resolved.