Skip to content
Exhale

Ask Exhale in plain language

POST
/api/v1/assistant/messages
curl --request POST \
  --url http://127.0.0.1:8484/api/v1/assistant/messages \
  --header 'Content-Type: application/json' \
  --data '{ "reset": true, "text": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
reset

Forget the conversation first; with an empty text it only forgets

boolean
text
required

What the person typed

string
<= 4000 characters

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
mentions
required

Subscriptions the answer talks about, for links

Array<object> | null
object
id
required
string
name
required
string
note

Why the answer may be incomplete, e.g. the step limit was reached; a translatable text

object
args
required
Array | null
key
required
string
proposals
required

Changes prepared for the person to confirm or discard; nothing is applied until they confirm

Array<object> | null
object
destructive
required

It deletes or cancels

boolean
id
required
string
lines
required

The details of the change, as translatable texts

Array<object> | null
object
args
required
Array | null
key
required
string
title
required

What would happen, e.g. Add Netflix, as a translatable text

object
args
required
Array | null
key
required
string
tool
required

The use case that would run, e.g. create_subscription

string
screens
required

Screens the model chose to show; every name and number in them comes from the database

Array<object> | null
object
charges

Kind charges: the period and its charges

object
$schema

A URL to the JSON Schema for this object.

string format: uri
charges
required
Array<object> | null
object
amount
required
object
currency
required
string
minor
required
integer format: int64
cancelBy
string
cancelPassed
required
boolean
chargedAmount
object
currency
required
string
minor
required
integer format: int64
daysUntil
required
integer format: int64
decision
string
delayed
required
boolean
dueDate
required
string
id
required
string
kind
required
string
Allowed values: renewal trial expiry
logo
string
note
string
originalDate
required
string
paymentMethod
string
resolvedAt
string format: date-time
status
required
string
subscriptionId
required
string
subscriptionName
required
string
updatedAt
required
string format: date-time
version
required
integer format: int64
from
required
string
to
required
string
kind
required
string
Allowed values: subscriptions charges total
more

Records left out because the screen is full

integer format: int64
subscriptions

Kind subscriptions: in the order the model chose

Array<object> | null
object
account
string
altPrice
object
price
required
object
currency
required
string
minor
required
integer format: int64
unit
required
string
Allowed values: month year
askUsage
required
boolean
autoConfirm
required
boolean
billingDay
string
cadence
required
string
cancelBy
string
cancelUrl
string
categoryId
string
categoryName
string
createdAt
required
string format: date-time
createdBy
string
expires
required
boolean
householdId
required
string
id
required
string
inTrial
required
boolean
logo
string
monthlyCost
required
object
currency
required
string
minor
required
integer format: int64
name
required
string
nextCharge
string
nextPrice
object
from
required
string
price
required
object
currency
required
string
minor
required
integer format: int64
nextScheduled
string
notes
string
noticeDays
integer format: int64
payerId
string
payerName
string
paymentMethod
string
paymentMethodId
string
planSwitch
object
currentYearly
required
object
currency
required
string
minor
required
integer format: int64
otherYearly
required
object
currency
required
string
minor
required
integer format: int64
yearlySaving
required
object
currency
required
string
minor
required
integer format: int64
price
required
object
currency
required
string
minor
required
integer format: int64
reminders
required
object
confirmAfterDays
required
integer format: int64
confirmEveryDays
required
integer format: int64
confirmTimes
required
integer format: int64
daysBefore
required
Array<integer> | null
hour
required
integer format: int64
minute
required
integer format: int64
renewal
string
schedule
required
object
maxCharges
integer format: int64
until
string
versions
required
Array<object> | null
object
from
required
string
rule
required
object
anchor
required
string
dayRule
string
interval
required
integer format: int64
unit
required
string
weekendShift
string
serviceUntil
string
shares
Array<object> | null
object
memberId
required
string
weight
required
integer format: int64
startedOn
string
status
required
string
tags
Array<string> | null
trialEndsOn
string
updatedAt
required
string format: date-time
url
string
usage
object
at
required
string format: date-time
using
required
boolean
version
required
integer format: int64
visibility
required
string
yearlyCost
required
object
currency
required
string
minor
required
integer format: int64
total

Kind total

object
by
required
string
Allowed values: category payment_method subscription
converted
required

Other currencies were converted at the latest ECB reference rate

boolean
period
required
string
Allowed values: month year
rows
required

Largest first

Array<object> | null
object
amount
required
object
currency
required
string
minor
required
integer format: int64
count
required
integer format: int64
label
required
string
subscriptionId

When the breakdown is by subscription

string
total
required

In the main currency

object
currency
required
string
minor
required
integer format: int64
unconverted
required

Currencies without a known rate, left out

Array<string> | null
text
required

The answer, plain text

string

Example 

{
  "$schema": "https://example.com/api/schemas/AssistantTurn.json",
  "screens": [
    {
      "charges": {
        "$schema": "https://example.com/api/schemas/ChargeList.json",
        "charges": [
          {
            "kind": "renewal"
          }
        ]
      },
      "kind": "subscriptions",
      "subscriptions": [
        {
          "altPrice": {
            "unit": "month"
          }
        }
      ],
      "total": {
        "by": "category",
        "period": "month"
      }
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}