List of streaming events?

When using the streaming API I basically follow the code examples shown here to create a run: https://platform.openai.com/docs/api-reference/runs

Is there a full list of possible events and maybe even a flow graph?
The happy path works well but I am concerned that there might arrive events I just did not consider arriving because I don’t know them.

Scroll a bit further, and you get the possible server-sent-events (to be transmitted in server-sent-events) along with the type of object they are producing.

https://platform.openai.com/docs/api-reference/assistants-streaming/events

The API reference being a reference, any additions should be noted there, with you gracefully dropping unknown types.

I could see the usefulness of opening this up to other events, for example, a thread.message.annotation event to markup a citation reference just produced.

1 Like