latestOpenAPI 3.1.02026-08-18112878.7 KB

0b8d2bc38f5d

Decisions

Start - Start a new session

Start a session with the reasoning engine, specifying the knowledge map and (optionally) the version you require.<br><br> By default it will start a session using the live version. If no version has been set live it will default to the draft version.<br><br> Alternatively the query parameters “useDraft” or “version” can be used as an override to request either the draft or a specific version. We recommend using a new session for each query, unless you need to make multiple queries within the same context.

get/start/{kmID}

Path parameters

kmIDstring required

The knowledge map ID to start a session against, this is in GUID format and can be obtained by clicking View Knowledge Map ID in the map details menu

Query parameters

useDraftboolean

Flag to use the draft version of the knowledge map, cannot be used simultaneously with 'version' parameter

versioninteger

Parameter to use a specific version of the map, cannot be used simultaneously with 'useDraft' parameter

Response

Session start information

idstring

ID of newly created session

Example response

{
  "id": "c1bf18d7-d1f0-44bc-a639-8cd4ded56dce",
  "kmVersion": {
    "id": "77135768-7634-49f0-9fbf-ed915ce08a66"
  }
}