Flows

Structured flow answers

The reason to run a flow. /messages returns raw text with no step id and no chip payload, so results were otherwise only recoverable by re-parsing a transcript and guessing which reply answered which question.

Safe to poll; also announced as a completed event on GET /v1/events.

get/v1/conversations/{id}/answers

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/conversations/{id}/answers
  • Auth: HTTP bearer

Path parameters

idstring required

Conversation id.

Response

Answers so far.

conversationIdstring
statestring

The conversation's own state, e.g. OPEN, CLOSED, CLOSED_OPTOUT.

outcome'awaiting_reply' | 'completed' | 'closed_early' | 'opted_out'
finalboolean

True when nothing further will arrive on this conversation.

flowIdstring required
flowNamestring
doneboolean required

True once the closing has been sent.

completionnumber required

Fraction of the flow's base steps answered, 0–1. Follow-ups are bonus and do not inflate it.

currentStepIdstring nullable

Null when the flow is done.

Changes

No recorded changes to this operation across all 1 revision of this API.