Read traces from each SSE trace event. Set config.completionEvents: true on your Streaming request to receive generated-text chunks.
completion
Marks a model completion event during the turn. Streaming clients receive the completion lifecycle described under completion event traces.
“Required” above means required in every payload shape. A field can be required for a particular state or event even when it is not required in every shape; the schema below defines those conditions.
completion payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
reasoning
Marks model reasoning activity during the turn. The payload’s state field selects the shape: content carries a content string, final carries a message, and start and end carry the state alone.
“Required” above means required in every payload shape. A field can be required for a particular state or event even when it is not required in every shape; the schema below defines those conditions.
reasoning payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
tool-call
Marks a tool call made by the agent during the turn. The payload always carries the callID and a state of start or end; a start may also carry a sound.
“Required” above means required in every payload shape. A field can be required for a particular state or event even when it is not required in every shape; the schema below defines those conditions.
tool-call payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
knowledgeBase
Reports a knowledge base retrieval: the chunks returned and the query that produced them.
knowledgeBase payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
block
Marks the conversation entering a block, identified by its block ID.
block payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
flow
Marks the conversation entering a flow, identified by its diagram ID.
flow payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
path
Reports which path the conversation took out of a step.
path payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
debug
Debug output for the turn, with a message and optional level, context, and metadata. Surfaced in agent logs rather than to end users.
debug payload schema
Look up nested fields, conditional requirements and constraints.
This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.
log
Diagnostic log output attached to the turn. The payload is always present and is a free-form object: the spec declares no named fields on it and permits any.
Custom actions
Custom action traces can be returned by functions and use the string you defined in Voiceflow as the type value. The defaultPath field indicates which path is set as the default: 0 for the first path, 1 for the second, and so on. Their payload is provided as JSON, as shown: