Skip to content

Commit edb3bc9

Browse files
committed
sdk readme update / npm published
1 parent a3bb9c5 commit edb3bc9

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

augmentos_cloud/packages/sdk/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@augmentos/sdk",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"main": "dist/index.js",
55
"types": "dist/index.d.ts",
66
"exports": {

augmentos_cloud/packages/sdk/src/tpa/server/index.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,22 @@ import {
3131
* ```
3232
*/
3333
export interface TpaServerConfig {
34-
/** 📦 Unique identifier for your TPA (e.g., 'org.company.appname') */
34+
/** 📦 Unique identifier for your TPA (e.g., 'org.company.appname') must match what you specified at https://console.augmentos.org */
3535
packageName: string;
3636
/** 🔑 API key for authentication with AugmentOS Cloud */
3737
apiKey: string;
3838
/** 🌐 Port number for the server (default: 7010) */
3939
port?: number;
40-
/** 🛣️ Custom path for the webhook endpoint (default: '/webhook') */
40+
41+
/** 🛣️ [DEPRECATED] do not set: The SDK will automatically expose an endpoint at '/webhook' */
4142
webhookPath?: string;
4243
/**
4344
* 📂 Directory for serving static files (e.g., images, logos)
4445
* Set to false to disable static file serving
4546
*/
4647
publicDir?: string | false;
47-
/** 🔌 WebSocket server URL for AugmentOS Cloud (default: 'wss://staging.augmentos.org/tpa-ws') */
48+
49+
/** 🔌 [DEPRECATED] No need to set this value */
4850
augmentOSWebsocketUrl?: string;
4951
/** ❤️ Enable health check endpoint at /health (default: true) */
5052
healthCheck?: boolean;
@@ -73,7 +75,8 @@ export interface TpaServerConfig {
7375
*
7476
* const server = new MyAppServer({
7577
* packageName: 'org.example.myapp',
76-
* apiKey: 'your_api_key'
78+
* apiKey: 'your_api_key',
79+
* publicDir: "/public",
7780
* });
7881
*
7982
* await server.start();

0 commit comments

Comments
 (0)