Give Feedback

dots.v2.actionGateway.sessions.get()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.actionGateway.sessions.get(requestConfiguration?: RequestConfiguration<SessionsRequestBuilderGetQueryParameters>): Promise<undefined | List_sessions_response>

Description

Returns the sessions you can see, newest first. Offset-paged with page and per_page; end_user_id filters to one actor.

Parameters

endUserId string optional

Example: alice

Optional actor_id, matched exactly.

page integer optional

Example: 1

1-based page number. Values below 1 are treated as 1.

Default: 1

Min: 1

perPage integer optional

Example: 20

Page size. Defaults to 20; values above 100 are capped at 100.

Default: 20

Min: 1

Max: 100

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.actionGateway.sessions.get();

Response Example

Show Response Example

{
  "sessions": [
    {
      "sessionUrn": "do:managed_agent_session:2b3c9f0e-1a4d-4e5f-8a7b-6c5d4e3f2a1b",
      "policy": {
        "defaultAction": "ask",
        "rules": [
          {
            "tool": "toolbelt:search-toolbelt@1",
            "match": {},
            "action": "allow"
          },
          {
            "tool": "jira_create_issue",
            "match": {},
            "action": "ask"
          }
        ]
      },
      "createdAt": "2026-09-24T12:00:00Z",
      "updatedAt": "2026-09-24T12:00:00Z",
      "name": "support-bot-alice",
      "actorId": "alice",
      "tools": {
        "references": [
          {
            "kind": "SESSION_TOOL_REFERENCE_KIND_TOOLBELT",
            "name": "search-toolbelt",
            "version": "1"
          },
          {
            "kind": "SESSION_TOOL_REFERENCE_KIND_TOOL",
            "name": "jira_create_issue",
            "version": "1"
          }
        ]
      },
      "config": {
        "preloadTools": [
          "exa_web_search"
        ],
        "outputViews": {
          "exa_web_search": "titles-and-urls"
        }
      },
      "agentUrn": "",
      "agentName": "",
      "owning_user_id": "2f8e1c3a-6b4d-4f7e-9a1c-5d3b7e9f1a2c"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}

More Information

See /v2/action-gateway/sessions in the API reference for additional detail on responses, headers, parameters, and more.