Skip to main content

LLMGenerationStartedEvent

Section ID: DOC-API-EVENT-u20phhssrl#overview

Event emitted when a generation run starts. The event context identifies the associated conversation. Use this in a guide: Event catalog

Payload​

Section ID: DOC-API-EVENT-u20phhssrl#payload

Payload fields: LLMGenerationStartedEvent.

Payload examples​

Section ID: DOC-API-EVENT-u20phhssrl#examples

These are illustrations of the selected payload Schema, not complete delivery envelopes. Transport metadata is supplied by the platform.

event-llm-generation-started​

Section ID: DOC-API-EVENT-u20phhssrl#example-event-llm-generation-started

Illustrative payload, not a captured delivery. Identifiers, tool names and outcomes are examples; omitted fields depend on the event.

API JSON uses JSON field names (camelCase).

{
  "runId": "9d4c2e1f-27b1-4304-ae54-af7fe876df31",
  "startingSequence": "1"
}

Notes​

Section ID: DOC-API-EVENT-u20phhssrl#notes

In the live view, this event replaces the status view for the individual generation run within its conversation.

Event-specific delivery guarantees, ordering, retention and lifecycle status are unspecified.

Audiences​

Section ID: DOC-API-EVENT-u20phhssrl#audiences

  • Audience: Live view Current conversation client projection.

  • Audience: Tenant webhook Sent to subscribed tenant webhook endpoints.

Delivery and lifecycle​

Section ID: DOC-API-EVENT-u20phhssrl#declared-intent

  • Live write intent: Replace

Live destination meaning​

Section ID: DOC-API-EVENT-u20phhssrl#live-destination-meaning

Status view for the individual generation run within its conversation.

Document ID: DOC-API-EVENT-u20phhssrl