| Field | Type | Required | Description |
|---|---|---|---|
input |
PlatformChatCreateStreamInput | ✔️ | Either a plain string (single user turn) or a chronological array of USER/ASSISTANT messages. The final array message must be USER. |
stream |
Optional<Boolean> | ➖ | N/A |
store |
Optional<Boolean> | ➖ | When true (default), persist the interaction and return a conversation_id. When false, run ephemerally with no persistence. |
conversationId |
Optional<String> | ➖ | Continue an existing stored conversation. Incompatible with message-array input and with store: false. |
text |
Optional<PlatformChatCreateStreamText> | ➖ | Optional configuration for the assistant's text response. When format.type is JSON_SCHEMA, the response is constrained to the supplied JSON schema and returned in output[*].content[*].structured_output. Structured output is not supported when stream is true. |