The context object is used to exchange information between the user and the app. This reference page provides details on the properties found in the context object, the parameters of any app’s entry point.

from cycls import App
...
@app
def entry_point(context):
  ...

Properties

id
uuid

Unique identifier for the conversation context. All exchanges between the user and the app within the same context will share this ID.
Example: 123e4567-e89b-12d3-a456-426614174000

message
object

An object representing the user’s message. It includes various sub-properties.

history
list[message]

A list of previous messages in the conversation, providing context and continuity.

send
object

Allows the user to send a complete message.
⚠️Currently, only text messages are supported.⚠️

stream
object

Enables the developer to send a message stream instead of a full message.
⚠️Currently, only text messages are supported.⚠️