List Sessions For Agents

GET/api/v2/aipAgents/agents/allSessions

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.

List all conversation sessions between the calling user and all accessible Agents that were created by this client. Sessions are returned in order of most recently updated first.

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

Query parameters

pageSize

integer

optional

The maximum number of sessions to return in a single page. The maximum allowed value is 100. Defaults to 100 if not specified.

pageToken

string

optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

preview

boolean

optional

Enables the use of preview functionality.

Response body

AgentsSessionsPage

object

A page of results for sessions across all accessible Agents for the calling user. Sessions are returned in order of most recently updated first.

Hide child attributes

nextPageToken

string

optional

The page token that should be used when requesting the next page of results. Empty if there are no more results to retrieve.

data

list<Session>

optional

Show child attributes

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/aipAgents/agents/allSessions?preview=true"

Response

Copied!

{
  "data": [
    {
      "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"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

Error responses

Error Name
`GetAllSessionsAgentsPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The calling user does not have permission to list all sessions across all Agents. Listing all sessions across all agents requires the `api:aip-agents-write` scope.
	Parameters
`ListSessionsForAgentsPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not allSessions the Agent.
	Parameters

See Errors for a general overview of errors in the platform.