API Reference

Get Session

GET/api/v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get the details of a conversation session between the calling user and an Agent.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-read.

Path parameters

agentRid

string

An RID identifying an AIP Agent created in AIP Agent Studio.

sessionRid

string

The Resource Identifier (RID) of the conversation session.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

Session

object

Hide child attributes

rid

string

The Resource Identifier (RID) of the conversation session.

metadata

object

Metadata about the session.

Show child attributes

agentRid

string

The Resource Identifier (RID) of the Agent associated with the session.

agentVersion

string

The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time.

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions/ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6?preview=true"

Response

Copied!

{
  "metadata": {
    "updatedTime": "2024-10-01T22:04:24.962583055Z",
    "estimatedExpiresTime": "2024-10-02T22:04:24.962583055Z",
    "messageCount": 6,
    "createdTime": "2024-10-01T20:04:24.962583055Z",
    "title": "What is the status of my order?"
  },
  "agentRid": "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1",
  "agentVersion": "1.0",
  "rid": "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
}