DOC-API-MODEL-schema-pnv14jb39g#overview
LLMGenerationStartedEvent
Event emitted when a generation run starts. The event context identifies the associated conversation.
Meaning and usage
Section ID: DOC-API-MODEL-schema-pnv14jb39g#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-pnv14jb39g#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-pnv14jb39g#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pnv14jb39g#request-field-runidrunId | string | Optional | Unique identifier for the workflow run |
Section ID: DOC-API-MODEL-schema-pnv14jb39g#request-field-configconfig | GenerationConfig | Optional | Optional snapshot of generation configuration used for this run |
Section ID: DOC-API-MODEL-schema-pnv14jb39g#request-field-startingsequencestartingSequence | string (int64) | Optional | Conversation sequence number at the moment the run started (if known) Pattern: ^-?\d+$. |
In responses
Section ID: DOC-API-MODEL-schema-pnv14jb39g#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pnv14jb39g#field-runidSection ID: DOC-API-MODEL-schema-pnv14jb39g#response-field-runidrunId | string | Optional | Unique identifier for the workflow run |
Section ID: DOC-API-MODEL-schema-pnv14jb39g#field-configSection ID: DOC-API-MODEL-schema-pnv14jb39g#response-field-configconfig | GenerationConfig | Optional | Optional snapshot of generation configuration used for this run |
Section ID: DOC-API-MODEL-schema-pnv14jb39g#field-startingsequenceSection ID: DOC-API-MODEL-schema-pnv14jb39g#response-field-startingsequencestartingSequence | string (int64) | Optional | Conversation sequence number at the moment the run started (if known) Pattern: ^-?\d+$. |
Examples
Section ID: DOC-API-MODEL-schema-pnv14jb39g#examples
event-llm-generation-started
Section ID: DOC-API-MODEL-schema-pnv14jb39g#example-event-llm-generation-started
Illustrative payload, not a captured delivery. Identifiers, tool names and outcomes are examples; omitted fields depend on the event.
{
"runId": "9d4c2e1f-27b1-4304-ae54-af7fe876df31",
"startingSequence": "1"
}
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-pnv14jb39g