Conversations

Start a new conversation with your AI agent. Returns a conversation ID and the initial greeting message.

Send a message in an existing conversation. The AI agent processes the message and returns the reply on this same request. There is no separate stream. Human Handoff: If the AI agent includes a Human Handoff node, the response may contain ended: true, which means the conversation has been transferred and closed. A support ticket or conversation has been created in the configured platform (HubSpot or Intercom) for a human agent to follow up. Book appointments: If this agent has the Book appointments skill and an appointment is confirmed on this turn, the response includes bookingCard — when (label, startsAt, endsAt, timezone), confirmationCode, scheduleName, and calendarUrl (a .ics file the visitor can add to their calendar). If you are not using scheduling, this field is omitted. You can ignore it. Product cards: If the agent shows a product from its photo catalog, the response includes productCards — an array of { id, name, description, priceLabel, imageUrl, sku, category, buyUrl, ctaLabel, options, variants }. Omitted when no product was shown.

Retrieve the full conversation history including all messages exchanged. Book appointments: Assistant messages that confirmed an appointment also include bookingCard (same shape as Send Message: when, confirmation code, and calendarUrl for an .ics file). If you are not using scheduling, this field is never returned. Product cards: Assistant messages that showed a product also include productCards (same shape as Send Message).