API Assist - Functions

Start a Function

POST /v2/assist/start

Type
Function

button

narrow_down

recommend

[List in "buttons" from /assist/load]

ask

ask

Body

Name
Type

access_token

string

type

string

function

string

context[]

Example: How hot is it in Spain?

context[]

Example: 2 Adults going from Spain to London

context[]

Example: Client Name: John Doe

Response

{
    "pollingUrl": "check?session=SESSIONID&type=ask&function=ask",
    "type": "ask",
    "function": "ask"
}

Check Status of Request

POST /v2/assist/check

Check the status of a Start Function

Body

Name
Type
Description

access_token

string

session

string

Pulled from Start Function

type

string

Pulled from Start Function

function

string

Pulled from Start Function

Response

{
  "running": true, // Will only show when AI is still running.
  "complete" true, // Will only show when AI is complete.
  "content": "" // JSON as String. "text" for ASK and Buttons will provide multiple keys.
}

Last updated