Create Turn
Run one conversation turn. Omit conversation_id to create the thread with this turn; pass it to continue an existing thread.
Authorizations
Headers
Optional user identifier to attribute clicks and sales to a user in your system. Channel3 appends it to buy URLs in the response.
Body
Run one turn. Without conversation_id a new thread is created first.
Existing thread to continue. When omitted, a new thread is created and its id returned.
Pinned catalog filters applied to every product search in this turn.
Optional search configuration, including collection_id.
Partner-supplied context pinned to the top of a conversation thread.
Stream turn events over SSE (default) or return the assembled turn as JSON.
Response
text/event-stream of TurnEvent objects (one data: JSON frame each), terminated by data: [DONE]. With stream: false, a buffered TurnResult JSON body instead.
- TurnStartedEvent
- PartStartedEvent
- PartDeltaEvent
- PartCompletedEvent
- TurnCompletedEvent
- TurnErrorEvent
First event of every turn; carries the ids clients need to correlate.