test-wuying-agentbay-sdk 0.13.1-beta.20251224103203 → 0.13.1-beta.20251224115652

package/docs/api/common-features/basics/session.md

@@ -25,6 +25,7 @@ Represents a session in the AgentBay cloud environment.
 - [getLabels](#getlabels)
 - [getLink](#getlink)
 - [getLinkAsync](#getlinkasync)
+- [getMetrics](#getmetrics)
 - [info](#info)
 - [listMcpTools](#listmcptools)
 - [pauseAsync](#pauseasync)
@@ -317,6 +318,33 @@ if (result.success) {
 
 ___
 
+### getMetrics
+
+▸ **getMetrics**(): `Promise`\<``SessionMetricsResult``\>
+
+Get runtime metrics for this session.
+
+The underlying service returns a JSON string. This method parses it and
+returns a structured result.
+
+#### Returns
+
+`Promise`\<``SessionMetricsResult``\>
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: "your_api_key" });
+const create = await agentBay.create({ imageId: "linux_latest" });
+if (create.success && create.session) {
+  const metrics = await create.session.getMetrics();
+  console.log(metrics.data);
+  await create.session.delete();
+}
+```
+
+___
+
 ### info
 
 ▸ **info**(): `Promise`\<`OperationResult`\>

package/docs/examples/README.md

@@ -20,6 +20,7 @@ examples/
 │   │   └── get/                   # Session retrieval
 │   └── advanced/                  # Advanced features
 │       ├── agent-module-example/  # AI-powered automation
+│       ├── session-metrics/       # Runtime metrics via MCP get_metrics
 │       ├── vpc-session-example/   # Secure isolated network environments
 │       └── archive-upload-mode-example/ # Archive upload mode
 ├── browser-use/                   # Browser automation (browser_latest)

package/docs/examples/common-features/advanced/session-metrics/README.md

@@ -0,0 +1,19 @@
+# Session Metrics Example (TypeScript)
+
+This example demonstrates how to retrieve **runtime metrics** for a session using `session.getMetrics()`.
+
+## Prerequisites
+
+- Node.js 16+
+- AgentBay API Key (set as environment variable `AGENTBAY_API_KEY`)
+
+## Run
+
+```bash
+export AGENTBAY_API_KEY=your_api_key_here
+
+cd typescript/docs/examples/common-features/advanced/session-metrics
+npx ts-node main.ts
+```
+
+

package/docs/examples/common-features/advanced/session-metrics/main.ts

@@ -0,0 +1,33 @@
+import { AgentBay } from "wuying-agentbay-sdk";
+
+async function main(): Promise<void> {
+  const apiKey = process.env.AGENTBAY_API_KEY;
+  if (!apiKey) {
+    throw new Error("AGENTBAY_API_KEY environment variable is not set");
+  }
+
+  const agentBay = new AgentBay({ apiKey });
+  const create = await agentBay.create({ imageId: "linux_latest" });
+  if (!create.success || !create.session) {
+    throw new Error(create.errorMessage || "failed to create session");
+  }
+
+  const session = create.session;
+  try {
+    const metrics = await session.getMetrics();
+    if (!metrics.success) {
+      throw new Error(metrics.errorMessage || "getMetrics failed");
+    }
+    console.log(metrics.data);
+  } finally {
+    await session.delete();
+  }
+}
+
+main().catch((err) => {
+  // eslint-disable-next-line no-console
+  console.error(err);
+  process.exit(1);
+});
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-wuying-agentbay-sdk",
-  "version": "0.13.1-beta.20251224103203",
+  "version": "0.13.1-beta.20251224115652",
   "description": "TypeScript SDK for interacting with the Wuying AgentBay cloud runtime environment",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",