Scenarios

These endpoints return the resolved state of a conversation’s scenarios — the domains, activities, and variables in effect — rather than the message-by-message history returned by GET /v1/conversations/:id.

All scenarios

GET /v1/conversations/:id/context

Returns every scenario in the conversation, each with its domains, activities, and variables.

{
  "conversation_id": "550e8400-...",
  "scenarios": [
    {
      "id": 1,
      "domains": [{ ... }],
      "activities": [{ ... }],
      "variables": [
        {
          "id": "...",
          "key": "monthly_payment",
          "title": "Monthly payment",
          "source": "calculated",
          "historical": false,
          "value": "2398.20 USD",
          "display": { ... }
        }
      ]
    }
  ]
}

The domains, activities and variables objects use the same shape as the results object in POST /v1/calculate. A conversation with no completed calculations returns an empty scenarios array.

A single scenario

GET /v1/conversations/:id/context/:scenario_id

Returns one scenario by its index.

{
  "conversation_id": "550e8400-...",
  "scenario": {
    "id": 1,
    "domains": [ "..." ],
    "activities": [ "..." ],
    "variables": [ "..." ]
  }
}

Conversations Domains

Introduction

Quickstart

Concepts

Domain Library

Playground

Authoring Domains

Data Types

Units

Function Library

API Reference

Resources

All scenarios

A single scenario

​All scenarios

​A single scenario

All scenarios

A single scenario