Create a chat response

Run an assistant turn. Set stream to true to receive server-sent events; otherwise the response is a typed JSON response object.

Request body

streamboolean

When true, respond with text/event-stream. When false or omitted, respond with application/json.

storeboolean

When true (default), persist the interaction and return a conversation_id. When false, run ephemerally with no persistence.

conversation_idstring

Continue an existing stored conversation. Incompatible with message-array input and with store: false.

{
  "input": "What is our parental leave policy?"
}

Successful response.

idstring required

Platform-owned, non-persisted response envelope identifier in resp_<uuid> form. The same identifier is used for every event in one streamed response.

object'RESPONSE' required

created_atstring date-time required

RFC 3339 UTC timestamp when the response was created.

status'COMPLETED' required

storeboolean required

conversation_idstring nullable

Present when the interaction was persisted.

request_idstring required