ResponsesAPIEvents
Add the following line to your scenario code to use the events:
require(Modules.OpenAI);
Constants
Contains information about connector.
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a partial code snippet is streamed by the code interpreter. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the code snippet is finalized by the code interpreter. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the code interpreter call is completed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a code interpreter call is in progress. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the code interpreter is actively interpreting the code snippet. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the model response is complete. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a new content part is added. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a content part is done. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An event that is emitted when a response is created. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Event representing a delta (partial update) to the input of a custom tool call. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Event indicating that input for a custom tool call is complete. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an error occurs. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An event that is emitted when a response fails. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a file search call is completed (results found). https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a file search call is initiated. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a file search is currently searching. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when there is a partial function-call arguments delta. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when function-call arguments are finalized. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an image generation tool call has completed and the final image is available. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an image generation tool call is actively generating an image (intermediate state). https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an image generation tool call is in progress. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a partial image is available during image generation streaming. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the response is in progress. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An event that is emitted when a response finishes as incomplete. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when there is a delta (partial update) to the arguments of an MCP tool call. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the arguments for an MCP tool call are finalized. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an MCP tool call has completed successfully. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an MCP tool call has failed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an MCP tool call is in progress. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the list of available MCP tools has been successfully retrieved. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the attempt to list available MCP tools has failed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when the system is in the process of retrieving the list of available MCP tools. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a new output item is added. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an output item is marked done. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when an annotation is added to output text content. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a response is queued and waiting to be processed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a new reasoning summary part is added. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a reasoning summary part is completed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a delta is added to a reasoning summary text. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a reasoning summary text is completed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a delta is added to a reasoning text. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a reasoning text is completed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when there is a partial refusal text. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when refusal text is finalized. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when there is an additional text delta. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when text content is finalized. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a web search call is completed. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a web search call is initiated. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted when a web search call is executing. https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)%20response_stream_event%20%3E%20(schema))
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Contains Responses API error.
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The unknown event.
Parameters
client:
The OpenAI.ResponsesAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.