CHchannel3-ai
v1

Create Turn

Changed on

Run one conversation turn. Omit conversation_id to create the thread with this turn; pass it to continue an existing thread.

post/v1/conversations

Request

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/conversations
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

x-user-idstring nullable

Optional user identifier to attribute clicks and sales to a user in your system. Channel3 appends it to buy URLs in the response.

Request body

conversation_idstring nullable

Existing thread to continue. When omitted, a new thread is created and its id returned.

streamboolean

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.

conversation_idstring required
turn_idstring required

Changes

  • de4ceb9ccdefRevision changes
    • info

      added the new optional request property /

  • f642382eaf91Revision changes
    • info

      added the new PL enum value to the request property //

    • info

      added the new PLN enum value to the request property //

    • info

      added the new pl enum value to the request property //