Sessions API¶

Endpoints for managing conversational sessions with your Agentic App.

Create a Session¶

Establishes a new conversation session for a specific user with the Agentic App.

Note: This is the starting point for any new interaction.

Method	POST
Endpoint	/apps/<AppID>/environments/<EnvName>/sessions
Content-type	application/json
Authorization Header	x-api-key: <API-KEY>

Path Parameters¶

Fields	Description
AppID	Unique Identifier for the app.
EnvName	Name of the environment to be used for the agent.

Request Parameters¶

Fields	Description
sessionIdentity	This is an array of objects with a `type` and `value` used to identify or create sessions and manage user session mappings. The three supported identifier types are: The objects can be of three types: userReference (highest priority) sessionReference sessionIdentity(lowest priority) Refer to [this](overview.md) for a detailed description.

Sample Request¶

{
  "sessionIdentity": [
    {
      "type": "userReference",  
      "value": "usr_1a2b3c4d5e"  //Your UserReference Value
    }
  ]
}

Response¶

Returns details of the newly created session, which are required for managing and continuing conversations. The response also includes document upload configuration and allowed file types, enabling clients to validate uploads in advance and prevent unnecessary failures. The fields in the response include:

session – Metadata about the created session.
- sessionId - A unique identifier for the session.
- Status - Indicates the current state of the session. Possible values: idle, busy, error.
- sessionReference - A unique reference string associated with the session for easier cross-request tracking.
- userReference - Unique reference string for the user associated with the session.
- userId - Internal system-generated identifier for the user.
- createdAt - Timestamp indicating when the session was created.
allowedMimeTypes – List of supported file formats for uploads.
fileUploadConfig – File Upload rules configured for the app. These rules apply to both types of documents - uploaded for context extraction and for Metadata generation. The following fields are available in this field.
- maxFileCount - Max number of files that can be uploaded.
- maxFileSize - Max size of each file that can be uploaded. The value is in MBs.
- maxTokens - Specifies the maximum allowed combined size of all uploaded files, measured in tokens. If the total token size exceeds this limit, only files that comply with the threshold are uploaded; files exceeding it will be rejected.

Sample Response¶

{
  "session": {
    "sessionId": "s-307d13e4-669c-42c0-8fec-a7653cb97627",
    "sessionReference": "s-123",
    "userReference": "s-123",
    "status": "idle",
    "userId": "u-0cc7b4f5-1b49-5c4c-958f-7d3a3263af2c",
    "createdAt": "2025-06-27T11:48:58.892Z"
  },
   "allowedMimeTypes": [
    "pdf",
    "docx",
    "doc",
    "txt",
    "json",
    "csv",
    "htm",
    "mle",
    "ppt",
    "xls",
    "gif",
    "png",
    "jpg",
    "jpeg",
    "html",
    "rtf",
    "bmp",
    "xlsx",
    "pptx"
  ],
  "fileUploadConfig": {
    "enabled": true,
    "maxFileCount": 2,
    "maxFileSize": 25,
    "maxTokens": 790000
  }
}

Sample Response¶

{
  "session": {
    "sessionId": "s-a302e3c6-308b-4a0a-9a5f-a01a5846fae1",
    "sessionReference": "Se_skwos333",
    "userReference": "usr_1a2b3c4d5e",
    "status": "idle",
    "userId": "u-4c2221e1-46c2-53c5-9876-fd6699052c15",
    "createdAt": "2025-02-17T19:07:00.070Z"
  }
}

Note: When a new session is initiated, and the application requires permissions for OAuth authorization from the user, the API response includes a special event of type IDP_Redirect.

This event provides a URL that the user must visit to complete the authorization process. If the required authorization is not completed, the associated tools will return an error upon invocation.

{
  "messageId": "msg-260f4d3c-5b8c-4056-af97-11317fc28c8d",
  "events": [
    {
      "type": "IDP_Redirect",
      "content": {
        "auth_profiles": [
          {
            "url": "https://{host}/r/396c63515671xxxxxxxxxx7955",
            "idpName": "Google",
            "isAuthorized": false,
            "sso_type": "oauth2"
          }
        ]
      }
    }
  ],
  "sessionInfo": {
    "status": "idle",
    "userReference": "s-b8987503-696b-4111-a006-49c0cbcf0fb9",
    "sessionReference": "s-b8987503-696b-4111-a006-49c0cbcf0fb9",
    "userId": "u-f5e5e830-70d4-53d6-8034-86bfa765c04a",
    "sessionId": "s-54f40bda-1505-4f9e-b38e-88d39ea36d58",
    "runId": "r-41ad20e0-6295-4f0e-9b04-e51875356107",
    "appId": "aa-c31cccce-d0bf-4db5-a177-7ff45941c2d8",
    "attachments": []
  },
  "allowedMimeTypes": [ "pdf","docx","doc","txt","json","csv","htm","mle","ppt","xls","gif","png","jpg","jpeg","html","rtf","bmp","xlsx","pptx"],
  "fileUploadConfig": {
    "enabled": true,
    "maxFileCount": 2,
    "maxFileSize": 10,
    "maxTokens": 100000
  }
}

List Sessions¶

Lists sessions for the selected app and environment. Supports optional filters such as session ID, user reference, and date range.

Method	POST
Endpoint	/apps/<AppID>/environments/<EnvName>/sessions/list
Content-type	application/json
Authorization Header	x-api-key: <API-KEY>

Path Parameters¶

Fields	Description
AppID	Unique Identifier for the app.
EnvName	The name of the environment in which the application will run.

Request Parameters¶

Fields	Description	Mandatory
sessionId	To filter sessions by a specific session ID, provide the unique session ID.	No
userReference	To Filter sessions by user reference, provide the userReference string.	No
date	To filter the sessions by date, provide the start and end dates.	No
filters	This field is for future implementation	No
offset	Number of records to skip (for pagination).	No

Sample Request¶

{
  "sessionId": "string",               
  "userReference": "string",           
  "date": {                           
    "start": "string",
    "end": "string"
  },
  "filters": [                        // For future use
    {
      "key": "string",
      "value": "string",
      "operator": "string"
    }
  ],
  "offset": "number"
}

Response Parameters¶

Fields	Description
sessions	Details of the sessions
pagination	Details related to pagination include the total number of matching sessions, the Index of the last item returned in this response, and whether more sessions are available beyond the current result.

Sample Response¶

{
  "sessions": [
    {
      "sessionId": "string",
      "sessionReference": "string",
      "status": "string",
      "userId": "string",
      "createdAt": "string"  // ISO timestamp
    }
  ],
  "pagination": {
    "totalCount": "number",
    "endIndex": "number",
    "hasMore": "boolean"
  }
}

Get Session¶

Fetches the details of a given session. You must provide either a sessionId or a sessionReference to uniquely identify the session.

Method	GET
Endpoint	/apps/<AppID>/environments/<EnvName>/sessions?sessionId={sessionId} /apps/<AppID>/environments/<EnvName>/sessions?sessionReference={sessionReference}
Content-type	application/json
Authorization Header	x-api-key:

Path Parameters¶

Fields	Description
AppID	Unique Identifier for the app.
EnvName	The name of the environment in which the application will run.

Query Parameters¶

Fields	Description	Required
sessionId	Unique Identifier for the session.	Optional(One of two is required )
sessionReference	The reference associated with the session	Optional (one of the two is required)

Note: Either sessionId or sessionReference must be provided to identify the session.

Sample Response¶

{ "session": 
  {
    "sessionId": "string",
    "sessionReference": "string",
    "status": "string",
    "userId": "string",
    "appId": "string",
    "createdAt": "string",
    "events": "string[]",
    "attachments": [
      {
        "fileId": "string",
        "filename": "string",
        "mimetype": "string",
        "isActive": "string",
      },
    ]
  }
}

Terminate Session¶

Terminates a given session. It also deletes the associated session-specific memory data.

Method	POST
Endpoint	/apps/<AppID>/environments/<EnvName>/sessions/terminate
Content-type	application/json
Authorization Header	x-api-key: <API-KEY>

Path Parameters¶

Fields	Description
AppID	Unique Identifier for the app.
EnvName	The name of the environment in which the application will run.

Request Parameters¶

Fields	Description	Mandatory
sessionIdentity	Provide the sessionReference or sessionId to uniquely identify the session to be terminated.	Yes

Sample Request¶

{
   "sessionIdentity": [
    {
      "type": "string",  // ["sessionReference", "sessionId"]
      "value": "s-1232123"
    }
  ]
}

Sample Response¶

{
  "status": "terminated",
  "userReference": "string",
  "sessionReference": "string",
  "userId": "string",
  "sessionId": "string",
  "appId": "string",
  "attachments": [
    {
      "fileId": "string",
      "fileName": "string",
      "fileType": "string",
    },
  ]
}

Send Feedback