Activity Events Contract

Activity events represent discrete actions performed by the LLM during processing (searching, opening pages, etc.). Below is field specifications contract for Events:

Field
Type
Required
Description

data_type

"activity"

✅ Yes

Always "activity" for activity events

data_value

string

✅ Yes

Stringified JSON containing activity details (see below)

id

string

⚠️ Recommended

Unique identifier per activity. Backend auto-generates if missing

Event Structure

{
  "data_type": "activity",
  "data_value": "{...}",  // Stringified JSON of activity data
  "id": "12345678-1234-1234-1234-123456789abc"
}

Data Value Inside Activity Event

For activity, we also have contract for field data_value . The data_value itself is stringified json with specifications:

Field
Type
Required
Description

type

string

✅ Yes

Activity type identifier (e.g., "search", "open_page")

message

string

⚠️ Recommended

Human-readable description.

Backend can auto-generate if missing. Type: Markdown.

Data Value structure

{
  "type": "activity_type_here",
  "message": "Human-readable description (optional but enforced)",
  ...additional type-specific fields
}

Last updated